Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jakjus/hax-climb
Haxball Server Script for Winky-type climbing maps.
https://github.com/jakjus/hax-climb
hax-climb haxball mod script
Last synced: 24 days ago
JSON representation
Haxball Server Script for Winky-type climbing maps.
- Host: GitHub
- URL: https://github.com/jakjus/hax-climb
- Owner: jakjus
- License: mit
- Created: 2022-08-13T12:51:21.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-08-26T12:23:19.000Z (4 months ago)
- Last Synced: 2024-11-08T17:52:16.398Z (about 2 months ago)
- Topics: hax-climb, haxball, mod, script
- Language: TypeScript
- Homepage:
- Size: 415 KB
- Stars: 3
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
⛰️ hax-climb
> Haxball Room Script for Climbing Mod (initial map & gameplay by Winky)
### 🚀 [Discord](https://discord.gg/dYk5UXs)
## Prerequisites
- npm >=8.6.0
- node >=16.0.0
## Install
```sh
git clone [email protected]: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`.
```ts
// config.ts
export default {
roomName: `🌕 HaxClimb v2.1.1 by jakjus`,
token: `YOUR_TOKEN_HERE`,
}
```
Run Server:
```sh
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 versions and some data exists!*
To migrate data (database) from v0.x.x to v1.x.x:
```
npm run migrate_v1
```
To migrate data (database) from v1.x.x to v2.x.x:
```
npm run migrate_v2
```
## Features
- [x] Winky's Climbing Challenge map
- [x] Checkpoint system
- [x] Timer
- [x] Leaderboards
- [x] SQLite database (persistent stats)
- [x] Multiple maps with separate leaderboards
- [x] Map Voting
## Author
👤 **Jakub Juszko**
* Website: https://jakjus.com
* Github: [@jakjus](https://github.com/jakjus)
* LinkedIn: [@jakubjuszko](https://linkedin.com/in/jakubjuszko)
## 🤝 Contributing
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/jakjus/hax-climb/issues).
## Show your support
Give a ⭐️ if this project helped you!
## 📝 License
Copyright © 2022 [Jakub Juszko](https://github.com/jakjus).
This project is [MIT](https://github.com/jakjus/hax-climb/blob/master/LICENSE) licensed.
***