openspades/README.md

54 lines
2.7 KiB
Markdown
Raw Normal View History

2013-08-17 23:56:25 -07:00
openspades
====================================================================================================
2013-08-18 16:55:06 +09:00
What is it?
----------------------------------------------------------------------------------------------------
2013-08-18 16:55:06 +09:00
OpenSpades is a compatible client of Ace of Spades 0.75.
2013-08-18 16:55:06 +09:00
* Can connect to a vanilla/pyspades/pysnip server.
* Uses OpenGL/AL for better visuals.
* Open source, and cross platform.
Installation
----------------------------------------------------------------------------------------------------
2013-08-18 16:55:06 +09:00
### On Linux
1. *On Debian-derived distributions*: ```sudo apt-get install pkg-config libsdl1.2-dev
libfltk1.3-dev libglew-dev libcurl3-openssl-dev``` (because of a bug in some distributions, you
might also have to install more packages by ```sudo apt-get install libjpeg-dev libxinerama-dev
libxft-dev```)
2. ```mkdir openspades.mk && cd openspades.mk && cmake .. && make OpenSpades```
2013-08-25 19:58:21 +09:00
3. ```sudo make install```
4. Two choices:
- Download windows binary of OpenSpades from
https://sites.google.com/a/yvt.jp/openspades/downloads, extract it, and copy the .pak files
inside Resources directory into `/usr/local/share/openspades/Resources` or
`~/.openspades/Resources`
- Download CMake, and run the cmake-gui (don't set the binary dir to be the same dir as your
project dir, but preferably set it to something like `OpenSpades.msvc` (this directory is
ignored by git).
2013-08-18 16:55:06 +09:00
5. ```openspades``` and enjoy
2013-11-01 21:22:54 +01:00
### On Windows (with visual studio)
1. Get CMake, Visual studio, and the OpenSpades source.
Official: https://github.com/yvt/openspades
Unofficial: https://github.com/learn-more/openspades
2013-11-02 04:01:48 +01:00
2. Extract or checkout the source (all examples will assume ```E:/Projects/openspades```, update paths in the examples to reflect yours)
3. Get (pre-compiled) copies of fltk, glew, curl, sdl and zlib, and place them in ```E:/Projects/openspades/Sources/Externals```.
See the file ```E:/Projects/openspades/Sources/Externals/readme.txt``` for details (and a pre-compiled set of libraries).
2013-11-01 21:22:54 +01:00
4. Run CMake, using the paths:
2013-11-02 04:01:48 +01:00
```Source: E:/Projects/openspades```
```Binaries: E:/Projects/openspades/OpenSpades.msvc```
For your convenience, create the directory: ```E:/Projects/openspades/OpenSpades.msvc/os.Resources```, extract the resources (.pak files) to this dir,
set ```OPENSPADES_RESDIR``` to point to this directory. (Run CMake again, now when running debug builds openspades will also read resources from this dir)
5. Open ```E:/Projects/openspades/OpenSpades.msvc/OpenSpades.sln``` in visual studio.
2013-11-01 21:22:54 +01:00
2013-08-18 16:55:06 +09:00
Licensing
----------------------------------------------------------------------------------------------------
2013-08-18 16:55:06 +09:00
Please see the file called LICENSE.
2013-08-18 16:58:10 +09:00
Note that other assets including sounds and models are not open source.