Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/matpow2/cuwo
Open server and utilities for Cube World
https://github.com/matpow2/cuwo
Last synced: 4 months ago
JSON representation
Open server and utilities for Cube World
- Host: GitHub
- URL: https://github.com/matpow2/cuwo
- Owner: matpow2
- License: gpl-3.0
- Created: 2013-07-08T18:13:00.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2020-10-01T13:46:36.000Z (over 4 years ago)
- Last Synced: 2024-07-31T22:51:11.082Z (7 months ago)
- Language: C
- Size: 3.93 MB
- Stars: 167
- Watchers: 33
- Forks: 49
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- License: COPYING.txt
Awesome Lists containing this project
README
[](https://travis-ci.org/matpow2/cuwo) [](https://ci.appveyor.com/project/matpow2/cuwo)
====
cuwo is an open server implementation for Cube World, written in Python and
C++. It currently has the best protocol coverage among all the server projects
out there, and has features like
* Cross-platform support (Linux, Windows, Mac OS X, FreeBSD, what have you)
* NPCs and mobs, just as in the regular server
* File/console logging
* MOTD message
* Scripting (see the minimal welcome.py example)
* Advanced configuration
* Ban system
* Commands (/kick, /say, /whereis, /setclock, /kill, /stun. etc.)
* Rights management (/login password)
* IRC bot
* PvP script
* DDoS prevention
* Lower CPU requirements than normal server
* Optimizations in C++
* Master server on http://cuwo.org
* Support for 40+ players
* ... and much more!
Note that cuwo only supports x86 and x86-64, so it will not work on ARM.
Running
=======
Windows
-------
See the
[quick-start guide](https://github.com/matpow2/cuwo/wiki/Quickstart) for a
quick way to get started.
Alternatively, you can also
[build from source](https://github.com/matpow2/cuwo/wiki/WindowsSource).
Source
------
Make sure you have Python >= 3.6, native compilers, and the following
dependencies installed:
* `cython`
* `pyrr`
If you want IRC bot support, you will also need the `irc3` package.
These packages can be installed with `pip install cython pyrr irc3`
To build cuwo, run `python setup.py build_ext --inplace`.
To run the server, run `python -m cuwo.server`.
For more information, see
[this guide](https://github.com/matpow2/cuwo/wiki/BuildSource).
Status
======
In terms of the protocol and features, the following has been implemented:
* Player join/leave
* Player movement and animations
* Magic/arrows/etc. relay
* Player hits on entities/other players
* Item pickup/drop
* Time management
* Terrain generator
* Interactive objects (doors, beds)
* Preliminary support for Mobs and NPCs
A lot is still to be implemented gameplay-wise. Most importantly, NPCs and mobs
have only recently been implemented, so expect some issues related to these.
Other features include
* MITM proxy (for reverse-engineering)
* Cube World/Qubicle model converter (tools/convertqmo.py)
* Map viewer (tools/mapviewer.py)
FAQ
===
* **Q.** I get `ImportError: No module named 'cuwo.entity'` when running cuwo.
* **A.** See the instructions for running/building cuwo.
* **Q.** How do I pronounce 'cuwo'?
* **A.** 'coo-woo' (no, not 'kew-woh')
* **Q.** I am not a programmer, and I can't reverse-engineer anything. How do
I help?
* **A.** We need people who can create end-user documentation as well! Have a
look around, and see if anything is missing on the wiki.
* **Q.** What is a MITM proxy?
* **A.** A MITM proxy sits between your client and server, and can manipulate
and inject packets. It's not really useful to the normal user, so
use the regular cuwo server instead.
Special thanks
==============
```
9th - help with RE
Andoryuuta - native RE
BLACKROCK - for help on passive packet
ChrisMiuchiz - native patches and RE
ColdMeekly - help with AMD 64bit troubleshooting
cs475x - website design
DRayX - encrypt.py and protocol RE
Endimmion - for his generous Pledgie donation
Favorlock - scripting and commands
Kainzo - testing
Kyle - master server JS
Lord_Nightmare - terraingen help and support with x86
MAT4DOR - cub model details
MazeXD - master server JS and design
Perl - protocol RE
Sarcen - help with protocol variables, scripting, anticheat
SLoW - scripting
Somer - help with some protocol variables
uwee - protocol variables
Xaymar - RE and character details
ZeZeene - web interface for master server
```