Shapez Vortex

A community-platform with tools to view, share & modify content 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:

• Node.js (JavaScript runtime) (with Corepack enabled)
• Docker (Test & Deployment)

Installation

1. Clone the repo

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

2. Install packages and start the services from the repository root:

   pnpm install
   cp apps/sveltekit/.env.example apps/sveltekit/.env
   pnpm dev:db
   pnpm dev

   Set POCKETBASE_URL in apps/sveltekit/.env (for local development, http://localhost:8080). Run pnpm dev:db and pnpm dev in separate terminals. SvelteKit also reads .env during builds; use .env.development instead if these values should apply only to development.

3. Visit localhost:5173

The pnpm workspace contains the SvelteKit application in apps/sveltekit and reserves packages/ for future packages. PocketBase and Caddy own their container definitions in apps/pocketbase and apps/proxy. Root compose.yml and compose.production.yml assemble those services. SvelteKit remains on Vercel: set the Vercel project's Root Directory to apps/sveltekit; its vercel.json is in that directory. Vercel does not accept Root Directory in vercel.json.

(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

To contribute to this project, have a look at the CONTRIBUTING for more information.

(back to top)

License

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

(back to top)

Contact / Support

To get in touch or support, see SUPPORT.

Repository Link

(back to top)