Shapez Vortex

A collection of tools to view, share & modify data of the game Shapez 2.

Website · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact

About The Project

This project started by passion for the game Shapez 2. I wanted to provide a tool to share visual information & content with other players, therefore I created this project.

The purpose of this project is to provide a suite of tools to visualize and modify data used by or generated from the game. You can also share content related to the game with other users.

In the current state it provides the following features:

• shape-viewer - visualize shapes by their identifier
• blueprint-codec - modify blueprint data
• blueprint-viewer - visualize blueprints

(back to top)

Built With

• 
• 
• 
• 
• 

(back to top)

Getting Started

Prerequisites

To setup, install & develop you may need some tools:

• Bun (JavaScript runtime & toolkit)
• Docker (Test & Deployment)

Installation

1. Clone the repo

   git clone https://github.com/DontMash/shapez-vortex.git

2. Install packages

     bun install

3. Visit localhost:5173

(back to top)

Roadmap

Visit the project overview to see what we are currently working.

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

Contact

Sören Maschmann - E-Mail

Repository Link

(back to top)