⛰️ hax-climb

Haxball Room Script for Climbing Mod (map and gameplay by Winky)

🚀 Discord

Prerequisites

• npm >=8.6.0
• node >=16.0.0

Install

git clone git@github.com:jakjus/hax-climb.git
cd hax-climb/
npm install

Usage

Rename config.example.ts with config.ts. Insert token from https://haxball.com/headlesstoken into config.ts.

// config.ts

export default {
    roomName: `🌕   HaxClimb v1.1 by jakjus`,
    token: `YOUR_TOKEN_HERE`,
}

Run Server:

npm start

Adding maps

To add a new map, follow the format in src/maps/jakjus-tower.ts. Then, add appropiate import in src/maps/maplist.ts. Map will be changed automatically.

Settings

Some script settings can be changed in src/settings.ts.

Migration (optional)

Only if you upgrade from v0.x.x to v1.x.x and some data exists!

To migrate data (database) from v0.x.x to v1.x.x:

npm run migrate

Features

• Winky's Climbing Challenge map
• Checkpoint system
• Timer
• Leaderboards
• SQLite database (persistent stats)
• Multiple maps with separate leaderboards
• Map Voting
• Multiple databases

Author

👤 Jakub Juszko

• Website: https://jakjus.com
• Github: @jakjus
• LinkedIn: @jakubjuszko

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2022 Jakub Juszko.
This project is MIT licensed.

---