griefly / griefly

Griefly: Yet Another Space Station Remake

Griefly

It is Griefly: Yet Another Space Station Remake.
Roadmap may be interesting to look into.

Dependencies

1. Some C++14 compiler (it works at least with compiler from Visual Studio 2015 and g++)
2. Qt5.8+
3. Python 3.5
4. Golang 1.5+ (https://golang.org/dl/)
5. Git
6. CMake 3.*

How to build everything on Windows

If you have any issues during the build process please report them

It should be possible to build everything without Qt Creator, but the guide assumes that Qt Creator is used.

1. All tools and libs from the dependencies list should be available on your machine. Tools and libs should be present in %PATH%
2. Open CMakeLists.txt in Qt Creator
   Open Project -> Select CMakeLists.txt -> Select build folder
3. Run CMake with param -DCMAKE_BUILD_TYPE=Release for Release verison.
4. Build the project.
   Client executables will appear in the exec folder, and the server executable will appear in the griefly-server folder.
   Client executables depend from various dlls, so it is needed to manually place them to the exec folder.

Note: It's supposed to be built from an active git repository (git describe --tags --abbrev=4 will be called during the process), otherwise it won't compile.

How to build everything on Linux

1. Install dependencies. Look into .travis.yml file for clues. (For Arch Linux only: All dependencies can be installed with sudo pacman -S git qt5-base qt5-multimedia go python mesa gcc)
2. cd into installation directory.
3. git clone https://github.com/griefly/griefly.git
4. cd griefly
5. ./make.sh. Built project will be placed under exec directory. Server will be built in gopath/src/griefly-server directory.

Note: It's supposed to be built from an active git repository (git describe --tags --abbrev=4 will be called during the process), otherwise it won't compile.
Note: gccgo is not supported! The current FindGo.cmake cannot parse the gccgo version string, so you will obtain an error. Use the official version instead.
Note: There may be some issues with CMake 3.0.2, so try to update your CMake if issues appear.

How to build everything on MacOS

1. Install dependencies using brew. brew install qt
2. Look at the tips in make.sh and adjust your environment accordingly.
3. ./make.sh. Build project will be placed under exec directory Server will be built in gopath/src/griefly-server directory.

How to start server

Server available in directory gopath/src/griefly-server. When hosting server, consider following adjustments:

1. Change password for admin user in db/auth.json. Passwords stored in plain text now.
2. When starting server, provide -server-url parameter. This parameter is an URL for asset server. It should be either host address (when server exposed to internet directly) or external ip (when running behind NAT). Server will bind on port, extracted from this url and clients will use url to connect to server for map exchange.

Other server options available in help: griefly-server -h

How to run game without launcher

Pass those command line parameters to KVEngine or KVEngine.exe:

First (master) client:
mapgen_name=<path_to_mapgen> login=<admin login> password=<admin password>
where login and password params values should match values in an auth database (by default griefly-server/db/auth.json), and path_to_mapgen should be path to some mapgen file. Some default mapgen files are places in the maps (e.g. maps/brig_small.gen).
Other clients:
login=Guest

You can also specify game host by parameter ip=game_host_address. By default it connects to localhost.

Launcher basically does same things, but in a more convenient for usual users way.

Codestyle

See documentation/CODESTYLE.md file for C++ codestyle. Use default ones for Python and Go (PEP8 and Go Coding Style accordingly).

griefly's Issues

Blinking of text when click

Copy vector in ForEach in CubeTile

Remove ForEach from Draw

IsVisibleFromTo

Check borders for visible points

Make IMovable

Many textures per file -> One texture per file

Map editor

title

Vsync linux support

wglSwapInterval = reinterpret_cast<PFNWGLSWAPINTERVALEXTPROC>(wglGetProcAddress("wglSwapIntervalEXT"));
if (wglSwapInterval) 
    wglSwapInterval(1);

some windows shit

List of sprites/sounds for load

AttackBy

Too long expressions

visiblePoint = 
    GetMapMaster()->losf.calculateVisisble(visiblePoint, 
        castTo<CubeTile>(thisMob->GetOwner().ret_item())->posx(), 
        castTo<CubeTile>(thisMob->GetOwner().ret_item())->posy(),
        castTo<CubeTile>(thisMob->GetOwner().ret_item())->posz());

Overlays

New map editor file format

Fix map editor, preshow state of item

Change sprite name system in one file

1. choose all image as opengl texture
2. name instead of number (hash?)

Atmosphere

Tools

screwdriver +
wrench
weldingtool
wirecutters +
crowbar +

View

PassableLevels

Differ play zone and gui zone

New system of creation items

Create item if it is not read only item, otherwise just use constant item.

Server bug

2014/06/30 22:05:13 client: recieved hello
2014/06/30 22:05:13 client: registering client
2014/06/30 22:05:13 client: registered as 0 master? true
2014/06/30 22:05:13 client: creating master...
2014/06/30 22:05:13 registry: attached master
2014/06/30 22:05:13 client: created master
2014/06/30 22:05:13 client[0]: starting main loop
2014/06/30 22:11:48 client: recieved hello
2014/06/30 22:11:48 client: registering client

First client try connect -> crush (some client trouble) -> second client connect -> ?????

GUI stuff, make it

Questinable

Make chat

Proper line-of-sight check

Hash misses

.dmi zTXt parser

Anchored

Remove hardcoded map size

Command line parsing

title

Lags when drawing items for the first time after long time

hearable_points_

Port main tiles from ss13

wall [x]
space [x]
floor [ ]
rwall [ ]

Server and disconnected clients

We don't handle disconnect of client.

String holder (number -> string, string -> number)

Nice autoplayer with linux support

Mouse message

Autogen preload sprites/images

Fast sync

Atmos move some stuff

AtmosTool

Save strings with 0 length

Make grilles and glass

Fix creation list for map editor

BlockCreationItemInsideItem()

Mysterious blinking texts

Fast IsPassable

Make turfs

Make doors

New downcasting without tons of templates

title