diff --git a/readme.md b/readme.md index dc57de0..a501a21 100644 --- a/readme.md +++ b/readme.md @@ -8,7 +8,12 @@ An in-dev game that I plan to make a shooter game out of. — reidlab # Setup -When you first setup this repository, you probably want to add your `.ROBLOSECURITY` cookie along with `MANTLE_AWS_ACCESS_KEY_ID` and `MANTLE_AWS_SECRET_ACCESS_KEY` into the `.env` file for automatic deployment with [Mantle](https://mantledeploy.vercel.app/). You also should change the ID of the game. +### Installing +`yarn install` +### Using +`yarn watch` and `yarn serve`, followed by a connection to Rojo. +### Deployment +When you first setup this repository, you probably want to add your `.ROBLOSECURITY` cookie along with `MANTLE_AWS_ACCESS_KEY_ID` and `MANTLE_AWS_SECRET_ACCESS_KEY` into the `.env` file for automatic deployment with [Mantle](https://mantledeploy.vercel.app/). You should also change the bucket names in [`./github/workflows/deploy.yml`](./github/workflows/deploy.yml). The thing is, your `.ROBLOSECURITY` cookie is locked to your region, so depending on what country you get from github actions, your deployment will fail. I recommend adding a self-hosted runner. # Hacks * I get a strange error about private identifiers in [`./src/ReplicatedStorage/ecs/state.ts`](./src/ReplicatedStorage/ecs/state.ts) @@ -16,7 +21,7 @@ When you first setup this repository, you probably want to add your `.ROBLOSECUR # Todo ### High priority -* Fix automatic deployment. `.ROBLOSECURITY` is region locked, so we have to change our region somehow. +* Fix automatic deployment. `.ROBLOSECURITY` is region locked, so we have to change our region somehow. In the morning, I'm gonna follow this guide: https://github.com/reidlabwastaken/goopler/settings/actions/runners/new?arch=arm64&os=linux, and do this shit with my raspberry pi * Add tests * Add guns. Try it in default roblox-ts and slowly reimplement it into our component system #### Medium priority