Terncode/pixel.horse
1
0
Fork 0
mirror of https://github.com/Terncode/pixel.horse.git synced 2026-09-24 21:55:52 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #126 from BytewaveMLP/clarify-docs

Browse Source 
Clarify initial sprites build, repo quirks
This commit is contained in:
Eliot Partridge
2019-09-19 11:58:54 -05:00
committed by GitHub
parent 786c283d54 417dd230f5
commit 857ceaa878
1 changed files with 15 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+15 -8
View File
@@ -204,25 +204,30 @@ node -e "console.log(require('crypto').randomBytes(64).toString('base64'))"
### Your first build ### Your first build
pixel.horse has modified the Pony Town archive such that compiled game assets are no longer included. To compile the game assets for the first time, you must use the following command, which will generate the necessary spritesheets and corresponding data. pixel.horse has modified the Pony Town archive such that compiled game assets are no longer included. To compile the game assets for the first time, you must use the following command, which will generate the necessary spritesheets and corresponding data **and** run a full production build of the site:
```bash
npm run build-sprites
npm start
```
**If you want to build sprites __only__** (useful if you want to develop the project before deployment), you can use:
```bash ```bash
gulp sprites gulp sprites
``` ```
If you would like to run a full production build after building spritesheets, you can use:
```bash
npm run build-sprites
```
### Production environment ### Production environment
After your initial build (see above), you can use the following commands to generate a fresh production build of the site.
```bash ```bash
npm run build npm run build
npm start npm start
``` ```
**This will not update spritesheets**; for that, you must use `npm run build-sprites` as discussed previously, or run a [development build](#running-in-development) with the `--sprites` flag.
### Beta environment (with dev tools and in-development features) ### Beta environment (with dev tools and in-development features)
```bash ```bash
@@ -312,7 +317,9 @@ Tools are accessible at `<base_url>/tools/` (only available in dev mode or when
- `src/ts/server/start.ts:35` - adding custom map to the world - `src/ts/server/start.ts:35` - adding custom map to the world
- `src/ts/server/map/customMap.ts` - commented introduction to customizing maps - `src/ts/server/map/customMap.ts` - commented introduction to customizing maps
## Have git ignore changes to `sprites.ts`, eventhough it's already in the index ## Repo quirks and notes
### `sprites.ts`
Due to an issue with the build system, an old copy of `src/ts/generated/sprites.ts` is shipped with this repository. In order to prevent Git from seeing changes to this file from local builds and warning you about them when changing branches or pulling new changes, you can use the following command: Due to an issue with the build system, an old copy of `src/ts/generated/sprites.ts` is shipped with this repository. In order to prevent Git from seeing changes to this file from local builds and warning you about them when changing branches or pulling new changes, you can use the following command: