ensl_gathers/README.md
Chris Blanchard 3c66ee3a30 Update readme
2015-08-19 14:54:20 +01:00

51 lines
858 B
Markdown

# ENSL Gathers App
## Status
A realtime micro web service to organise gathers for ENSL.org
## Design Goals
1) Create a nice place where the NS2 community can assemble and have fun
2) Create an efficient, easy-to-use and flexible system to create NS2 gathers
3) Support the modern web and basic usability expectactions (e.g. realtime, phone and tablet friendly)
That's it
## Requirements
- node.js 0.12
- MongoDB
## Run
```bash
npm install
npm start
```
## Todo
Required for Production:
- Admin tools: Modify Messages
- Admin tools: Remove gatherer
- ENSL.org: Pull bans
- ENSL.org: Archive gather on ensl.org
Nice to have:
- Hive.naturalselection2.com: Pull stats
- Steam: Outbound steam messaging
- Add sounds and configuration
- Add user profile + backend store
- Show online/away/offline status
- Picking order
## License
MIT Licensed