commit 99d6fe690d28c615b86fa6d94905dd575e4c73a2 Author: Sovereignty Date: Sat Apr 26 16:03:34 2025 +0000 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..2bb9810 --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +# Project place file +/*.rbxl +/sourcemap.json +# Roblox Studio lock files +/*.rbxlx.lock +/*.rbxl.lock +/.vscode +/.png \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..459c315 --- /dev/null +++ b/README.md @@ -0,0 +1,49 @@ +# Template Repository +Meant to be used as a template when creating new repositories. + +The default project json is a little advanced for some individuals' tastes. You are welcome to switch it out, or use one of the other provided project template files. +## Uses + +- Selene for linting +- Rojo for syncing +- Luau Language Server for syntax, intellisense, type checking, and intellisense syncing + +## How To Use +Go ahead and create a new repository by selecting the plus icon on the top right of the screen. + +![Select the plus icon in the top right corner of your screen](assets/image-1.png) + +A dropdown menu will open, pick the first option. + +![Select New repository](assets/image-2.png) + +When creating a new repository, you will be prompted with the chance to choose the template for your new repo. +Select this repository, and then select the options shown below. + +![Git content, Webhooks, Topics, Issue Labels, and Branch protection were selected underneath the chosen template repo](assets/image.png) + +## Installation + +- Luau Language Server [Link](https://marketplace.visualstudio.com/items?itemName=JohnnyMorganz.luau-lsp) + - Has an optional Roblox Studio plugin which allows for you to have intellisense for in-studio assets like Instances. + +- Rojo (One way syncing) [Link](https://marketplace.visualstudio.com/items?itemName=evaera.vscode-rojo) + - You will need the Roblox Studio pair version of this extension. + +- Selene Linting (Preferably download locally via cargo{rust}) [Link](https://marketplace.visualstudio.com/items?itemName=Kampfkarren.selene-vscode) + +- Stylua (Styling/Formatting) [Link](https://marketplace.visualstudio.com/items?itemName=JohnnyMorganz.stylua) + +## Info + +Use the init.meta.json to ignore descendant/neighbor files when syncing. This means that it will not overwrite non rojo files that may be present only in Roblox Studio. + +Clone this file into whatever folder this functionality would be applicable to you. + +## Branches + +The repository has two protected branches. +- main + - Does not allow for code to be pushed to main, and merging a branch into main requires approval before doing so. +- testing + - Does not allow for code to be pushed to testing, however merging is permitted as this branch is intended for testing code. \ No newline at end of file diff --git a/assets/image-1.png b/assets/image-1.png new file mode 100644 index 0000000..c11a856 Binary files /dev/null and b/assets/image-1.png differ diff --git a/assets/image-2.png b/assets/image-2.png new file mode 100644 index 0000000..8e2597d Binary files /dev/null and b/assets/image-2.png differ diff --git a/assets/image.png b/assets/image.png new file mode 100644 index 0000000..7e6f020 Binary files /dev/null and b/assets/image.png differ diff --git a/default.project.json b/default.project.json new file mode 100644 index 0000000..d342d33 --- /dev/null +++ b/default.project.json @@ -0,0 +1,43 @@ +{ + "name": "E_CS", + "tree": { + "$className": "DataModel", + + "ReplicatedStorage": { + "$path": "src/Replicated/Storage" + }, + + "ReplicatedFirst": { + "$path": "src/Replicated/First" + }, + + "ServerScriptService": { + "$path": "src/Server/Scripts" + }, + + "ServerStorage": { + "$path": "src/Server/Storage" + }, + + "StarterPlayer": { + "StarterPlayerScripts": { + "$path": "src/Local/Player" + }, + "StarterCharacterScripts": { + "$path": "src/Local/Character" + } + }, + + "Workspace": { + "$properties": { + "FilteringEnabled": true + } + }, + + "SoundService": { + "$properties": { + "RespectFilteringEnabled": true + } + } + } +} \ No newline at end of file diff --git a/init.meta.json b/init.meta.json new file mode 100644 index 0000000..1025b06 --- /dev/null +++ b/init.meta.json @@ -0,0 +1,3 @@ +{ + "ignoreUnknownInstances": true +} \ No newline at end of file diff --git a/selene.toml b/selene.toml new file mode 100644 index 0000000..a400496 --- /dev/null +++ b/selene.toml @@ -0,0 +1 @@ +std = roblox \ No newline at end of file diff --git a/src/Local/Player/runtime.client.lua b/src/Local/Player/runtime.client.lua new file mode 100644 index 0000000..e69de29 diff --git a/src/Replicated/Storage/Hello.luau b/src/Replicated/Storage/Hello.luau new file mode 100644 index 0000000..e69de29 diff --git a/src/Server/Scripts/runtime.server.lua b/src/Server/Scripts/runtime.server.lua new file mode 100644 index 0000000..e69de29