A multiplayer open-world YSWS program by Hack Club.
PIXL is a YSWS (You ship, We ship) program by Hack Club. It's created by Gabin, Ridit and Ricky and sponsored by Seba, on behalf of Hack Club to make it an official program! It started august 18th and is ending January 1st! You basically evolve in a multiplayer open world to discover regions and go talk to NPCs that will give you trials (prompted projects) for you to do and that will help to rebuild the civilisation. The whole story is explained during the cinematic when you enter the game for the first time so if that feels vague to you, go play that cinematic!
You can also create general projects and submit them as well!
You earn pixels from your hours and with those pixels, you can buy a ton of crazy stuff from our huge shop!
- Bun 1.3.13 or newer (the version pinned in
package.json) - Git
- Postgres for
apps/serverandapps/internal-dashboard - Godot 4 if you want to work on
apps/game - Credentials for the services an app uses (Slack, Hack Club Auth, and so on). Check that app's
.env.example.
Clone the repository and install every workspace's dependencies from the repo root:
git clone https://github.com/hackclub/pixl.git
cd pixl
bun installEach app has its own .env. Copy the example for the apps you want to run and fill in the values you have access to:
cp apps/server/.env.example apps/server/.env
cp apps/internal-dashboard/.env.example apps/internal-dashboard/.env
cp apps/pixl-dashboard/.env.example apps/pixl-dashboard/.env
cp apps/pixorpheus/.env.example apps/pixorpheus/.envIf you don't have database or Slack credentials, ask in the #pixl channel on Hack Club Slack. Many frontend contributions to apps/landing or apps/game don't need a full backend running.
Start every app's dev server at once:
bun run devOr start a single app:
bun run internal-dashboard # internal review/moderation dashboard, http://localhost:4900
bun run pixl-dashboard # player dashboard, http://localhost:4901Useful repo-wide commands:
bun run build # build every app
bun run --cwd apps/internal-dashboard test # run one app's testsTo run apps/game, open the project in the Godot 4 editor. It is not a Bun app, so don't run bun install in that folder.
- Read DEVELOPER.md for the architecture, local setup and deployment notes.
- Read CONTRIBUTING.md before opening a pull request.
- Ask in the
#pixlchannel on Hack Club Slack. - Open an issue for bugs or feature requests.
This project is licensed under the MIT License. See LICENSE for details.