A template repository for Core games. In general, setting up a new repository should take only a few minutes; use this repository as a way of finding example files, and use the following checklist to ensure that you've set up the repository correctly.
This template provides you a quick way to get started with a Core game project on GitHub. It includes the following config files:
.luacheckrcfor linting and error checking your game scripts. This file will get updated with almost every Core patch so make sure to stay up to date..gitignorefor preventing you from accidentally checking in unneeded files into the repository. For Core this includes screenshots and other user specific or temporary files..editorconfigfor setting up a consistent code style across the project.- Visual Studio Code extensions:
- If you are using VS Code, opening this project in it will cause a popup to appear that asks you if you want to install the recommended extensions for it.
- We suggest using at least the following two extensions: EditorConfig and Core Lua API.
Go through this checklist after creating your repository. It should only take a couple of minutes; if there is a way to make this more efficient, please open an issue or pull request with your suggestions.
- Delete or customize
CODE_OF_CONDUCT.md. - Delete or customize
CONTRIBUTING.md.
- Make sure
.editorconfigmatches your preferred code style.
- Delete or edit
LICENSEdepending on if you want to use the Apache 2 license or a different one. Make sure to replace the placeholders in it as well.
- Have you added a short description to the repository?
- Have you added topics to the GitHub repository:
core,coregames,lua,game, and so on?
- Replace
README.mdwith the contents ofexample-README.mdand then deleteexample-README.md. - Rename all instances of
$YOURGAMENAMEin the README to match your repo title. - Manually go through and edit the rest of the README.