Skip to main content

Setting Up

caution

SILK Game Framework is still in its early stages. For the time being, all immediate releases are considered to be pre-release versions until the framework is declared as being ready to be used in production.

Installation​

Go to GitHub Releases and download the attached .rbxm file from the latest release. Alternatively, download the source code and move the src folder to anywhere inside your project then rename it to "silk."

Project Structure​

A project can typically be structured in any way preferred by the developer. The following minimalistic structure shows an example of what an ideal project might look like.

Ideal project structure:​
Project
│
├─ ServerScriptService
│   ├─ initializer.server.lua 
│   └─ script.server.lua
│
├─ ReplicatedStorage
│   └─ silk
│       └─ ...
│
└─ StarterPlayer
    └─ StarterPlayerScripts
        ├─ initializer.client.lua
        └─ script.client.lua