Mascali

Archived

This repository has been archived on 2021-02-20. You can view files and clone it, but cannot push or open issues or pull requests.

Go to file

tobspr e4a8e72edd Add .itch.toml file		2020-05-30 20:25:46 +02:00
.github/workflows	Update github actions	2020-05-28 09:37:57 +02:00
.vscode	Initial commit	2020-05-09 16:45:23 +02:00
artwork	Preparations for the trailer	2020-05-30 17:50:29 +02:00
electron	add travis config to build standalone bundle on multiple platforms	2020-05-28 16:08:08 +02:00
gulp	Add .itch.toml file	2020-05-30 20:25:46 +02:00
res	Allow hovering pinned shapes to enlarge them	2020-05-30 19:42:03 +02:00
res_built	Initial waypoint support	2020-05-28 19:40:48 +02:00
res_raw	Initial waypoint support	2020-05-28 19:40:48 +02:00
src	Add .itch.toml file	2020-05-30 20:25:46 +02:00
tools/shape_generator	Fix splitters	2020-05-09 19:14:11 +02:00
translations	Minor improvements	2020-05-30 19:11:18 +02:00
.eslintignore	add all GH Actions work	2020-05-27 08:17:25 -04:00
.eslintrc.yml	Update github actions	2020-05-28 09:37:57 +02:00
.gitattributes	Track psd files in LFS	2020-05-23 13:04:16 +02:00
.gitignore	Update gitignore	2020-05-27 10:39:00 -04:00
.prettierrc.yaml	Update github actions	2020-05-28 09:37:57 +02:00
.travis.yml	add travis config to build standalone bundle on multiple platforms	2020-05-28 16:08:08 +02:00
CONTRIBUTORS	Add artwork folder and list of contributors	2020-05-20 13:50:20 +02:00
LICENSE	Update license	2020-05-21 15:08:30 +02:00
README.md	Update readme	2020-05-29 08:00:51 +02:00
buildutils.js	Initial commit	2020-05-09 16:45:23 +02:00
package.json	Add build scripts	2020-05-29 08:21:22 +02:00
shapez.code-workspace	Initial support for blueprints (Buggy)	2020-05-27 14:30:59 +02:00
version	Allow hovering pinned shapes to enlarge them	2020-05-30 19:42:03 +02:00
yarn.lock	add all GH Actions work	2020-05-27 08:17:25 -04:00

README.md

shapez.io

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.

Playing

You can already play it here.

Building

Make sure git git lfs extension is on your path
Run git lfs pull to download sound assets
Make sure ffmpeg is on your path
Install Yarn and Node.js 10
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

Notice: This will produce a debug build with several debugging flags enabled. If you want to disable them, modify config.js.

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.

If you want to add a new building, please understand that I can not simply add every building to the game! I recommend to talk to me before implementing anything, to make sure its actually useful. Otherwise there is a high chance of your PR not getting merged.

If you want to add a new feature or in generally contribute I recommend to get in touch with me on Discord:

Code

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.

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

For most assets I use Adobe Photoshop, you can find them in assets/.

You will need a Texture Packer 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. I'm currently switching to an open source solution but I can't give an estimate when thats done.