mirror of
https://github.com/tobspr/shapez.io.git
synced 2025-12-11 09:11:50 +00:00
a2d1e434bb
* Added information about community edition * Update README.md * README rewrite --------- Co-authored-by: EmeraldBlock <yygengjunior@gmail.com>
89 lines
4.5 KiB
Markdown
89 lines
4.5 KiB
Markdown
# shapez Community Edition <img src="./electron/favicon.png" alt="shapez Logo" align="right" height="40">
|
|
|
|
**shapez Community Edition** (abbreviated as **CE**) is a community-maintained version of [shapez](https://store.steampowered.com/app/1318690/shapez/)!
|
|
|
|
CE was created as the tobspr Games team moved away from shapez to work full-time on the upcoming [Shapez 2](https://store.steampowered.com/app/2162800/shapez_2/).
|
|
CE aims to:
|
|
|
|
- Continue the development of shapez as guided by the community.
|
|
- Allow contributors to continue submitting new features and improvements to the game.
|
|
- Provide an experimental and forgiving environment for faster development.
|
|
|
|
> [!IMPORTANT]
|
|
> CE is different from the official game published on Steam and other platforms.
|
|
> CE was forked off of the official shapez, which has [its own repository](https://github.com/tobspr-games/shapez.io).
|
|
> No plans exist to merge the two versions of shapez.
|
|
|
|
As of now, CE must be built from source and supports only a standalone build,
|
|
with no plans for re-supporting a web version.
|
|
In the future, builds of CE may provided for owners of the full version of shapez.
|
|
|
|
## Contributing
|
|
|
|
We communicate on the [official shapez Discord server](https://discord.com/invite/HN7EVzV).
|
|
For historical reasons, we have communicated in a private channel,
|
|
but we are moving to the public `#contributing` channel.
|
|
If you would like to contribute to CE, feel free to share your ideas, plans, etc. there.
|
|
|
|
In our current workflow, we (the "collaborators" of the repository) create internal branches and corresponding pull requests to work on a feature, refactor, etc.
|
|
We discuss changes in the Discord, and when 2 collaborators (including the PR creator) approve of a change, it can be merged.
|
|
See our existing [pull requests](https://github.com/tobspr-games/shapez-community-edition/pulls?q=) for examples.
|
|
|
|
If you are not a collaborator and want to submit a change,
|
|
you can fork our repo and make a pull request.
|
|
Note that because of plans to overhaul many parts of the game,
|
|
unless you are improving translations, you should probably communicate with us on Discord!
|
|
|
|
> [!TIP]
|
|
> Be aware that [pull requests to the official shapez repository](https://github.com/tobspr-games/shapez.io/pulls) are unlikely to get merged in the near future. Instead, submit them to CE!
|
|
> In fact, because the game is licensed under the [GNU GPL v3.0](https://www.gnu.org/licenses/gpl-3.0.html),
|
|
> existing pull requests can be resubmitted to CE even if you aren't the author! **This is not legal advice.**
|
|
|
|
### Code
|
|
|
|
The game uses a custom engine originally based on the YORG.io 3 game engine.
|
|
The code within the engine is relatively clean with some code for the actual game on top being hacky.
|
|
|
|
We are in the process of migrating to TypeScript and JSX/TSX.
|
|
New changes should be implemented in TypeScript if possible,
|
|
but because we are planning on overhauling many parts of the game,
|
|
there is no need to convert existing code to TypeScript.
|
|
|
|
This project is fine with using cutting-edge and bleeding-edge features
|
|
and does not intend to provide compatibility for older clients.
|
|
|
|
## Building
|
|
|
|
### Prerequisites
|
|
|
|
- [ffmpeg](https://www.ffmpeg.org/download.html)
|
|
- [Node.js 16](https://nodejs.org/en/about/previous-releases)
|
|
(not 17+, see <https://github.com/tobspr-games/shapez.io/issues/1473>)
|
|
- [Yarn 1](https://classic.yarnpkg.com/en/docs/install) (not 2, we haven't migrated yet)
|
|
- [Java](https://www.oracle.com/java/technologies/downloads/) (or [OpenJDK](https://openjdk.org/)) (to run texture packer)
|
|
|
|
### Development
|
|
|
|
- Run `yarn` in the root folder and in `electron/`.
|
|
- Run `yarn gulp` in the root folder to build and serve files.
|
|
Ignore the browser tab that opens.
|
|
- Open a new terminal and run `yarn startDev` in `electron/` to open an Electron window.
|
|
- Tip: If you open the Electron window too early, you can reload it when focused on DevTools.
|
|
|
|
### Release
|
|
|
|
> [!CAUTION]
|
|
> Release steps are currently unchecked and unmaintained and will likely be revised in the future.
|
|
|
|
- Run `yarn` in the root folder and in `electron/`.
|
|
- In the root folder, run `yarn gulp build.standalone-steam`.
|
|
- Run `yarn gulp standalone.standalone-steam.prepare`.
|
|
- Run `yarn gulp standalone.standalone-steam.package.$PLATFORM` where `$PLATFORM` is `win64`, `linux64`, or `darwin64` depending on your system.
|
|
- The build will be found under `build_output/standalone-steam` as `shapez-...-x64`.
|
|
|
|
## Credits
|
|
|
|
Thanks to [tobspr](https://tobspr.io) for creating this project!
|
|
|
|
[<img src="https://i.imgur.com/uA2wcUy.png" alt="tobspr Games">](https://tobspr.io)
|