Archives/tobspr_shapez.io
1
0
Fork 0
mirror of https://github.com/tobspr/shapez.io.git synced 2024-10-27 20:34:29 +00:00
Code Issues Projects Releases Wiki Activity

Readme fixes

Browse Source
This commit is contained in:
dengr1065 2020-05-26 19:33:37 +03:00
parent 1d9616f955
commit 8e67a46a97
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -2,28 +2,28 @@
<img src="https://i.imgur.com/Y5Z2iqQ.png" alt="shapez.io Logo"> <img src="https://i.imgur.com/Y5Z2iqQ.png" alt="shapez.io Logo">
This is the source code for shapez.io, an open source base building game inspired by factorio. This is the source code for shapez.io, an open source base building game inspired by Factorio.
Your goal is to produce shapes by cutting, rotating, merging and painting parts of shapes. Your goal is to produce shapes by cutting, rotating, merging and painting parts of shapes.
## Playing ## Playing
You can already play it on https://shapez.io You can already play it [here](https://shapez.io).
## Building ## Building
- Make sure ffmpeg is on your path - Make sure `ffmpeg` is on your path
- Install yarn and node 10 - Install Yarn and Node.js 10
- Run `yarn` in the root folder, then run `yarn` in the `gulp/` folder - Run `yarn` in the root folder, then run `yarn` in the `gulp/` folder
- Cd into `gulp` and run `yarn gulp`: It should now open in your browser - Cd into `gulp` and run `yarn gulp` - it should now open in your browser
**Notice**: This will give you a debug build with several debugging flags enabled. If you want to disable them, check `config.js` **Notice**: This will produce a debug build with several debugging flags enabled. If you want to disable them, modify `config.js`.
## Contributing ## Contributing
Since this game is in the more or less early development, I will only accept pull requests which add an immediate benefit. Please understand that low quality PR's might be closed by me with a short comment explaining why. Since this game is in the more or less early development, I will only accept pull requests which add an immediate benefit. Please understand that low quality PR's might be closed by me with a short comment explaining why.
If you want to add a new feature or in generally contribute I recommend to get in touch with me on discord: If you want to add a new feature or in generally contribute I recommend to get in touch with me on Discord:
<a href="https://discord.com/invite/HN7EVzV" target="_blank"> <a href="https://discord.com/invite/HN7EVzV" target="_blank">
<img src="https://i.imgur.com/SoawBhW.png" alt="discord logo" width="100"> <img src="https://i.imgur.com/SoawBhW.png" alt="discord logo" width="100">
@ -34,10 +34,10 @@ If you want to add a new feature or in generally contribute I recommend to get i
The game is based on a custom engine which itself is based on the YORG.io 3 game egine (Actually it shares almost the same core). The game is based on a custom engine which itself is based on the YORG.io 3 game egine (Actually it shares almost the same core).
The code within the engine is relatively clean with some code for the actual game on top being hacky. The code within the engine is relatively clean with some code for the actual game on top being hacky.
This project is based on ES5. Some es6 features are used but most of them are too slow, especially when polyfilled. For example, `.forEach` is only used within non-critical loops since its slower than a plain for loop. This project is based on ES5. Some ES2015 features are used but most of them are too slow, especially when polyfilled. For example, `Array.prototype.forEach` is only used within non-critical loops since its slower than a plain for loop.
### Assets ### Assets
For most assets I use photoshop, you can find them in `assets/`. For most assets I use Adobe Photoshop, you can find them in `assets/`.
You will need a <a href="https://www.codeandweb.com/texturepacker" target="_blank">texture packer</a> license in order to regenerate the atlas. If you don't have one but you want to contribute assets, let me know and I might compile it for you. You will need a <a href="https://www.codeandweb.com/texturepacker" target="_blank">Texture Packer</a> license in order to regenerate the atlas. If you don't have one but want to contribute assets, let me know and I might compile it for you.