{"id":13441200,"url":"https://github.com/griefly/griefly","last_synced_at":"2025-03-20T11:37:42.865Z","repository":{"id":11903372,"uuid":"14467191","full_name":"griefly/griefly","owner":"griefly","description":"Griefly: Yet Another Space Station Remake","archived":false,"fork":false,"pushed_at":"2019-07-11T07:43:29.000Z","size":64162,"stargazers_count":130,"open_issues_count":130,"forks_count":25,"subscribers_count":23,"default_branch":"master","last_synced_at":"2024-08-01T03:33:38.612Z","etag":null,"topics":["c-plus-plus","cmake","game","go"],"latest_commit_sha":null,"homepage":"https://grief.ly","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/griefly.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-11-17T13:30:16.000Z","updated_at":"2024-06-26T10:06:06.000Z","dependencies_parsed_at":"2022-09-07T05:31:06.492Z","dependency_job_id":null,"html_url":"https://github.com/griefly/griefly","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/griefly%2Fgriefly","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/griefly%2Fgriefly/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/griefly%2Fgriefly/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/griefly%2Fgriefly/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/griefly","download_url":"https://codeload.github.com/griefly/griefly/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221759943,"owners_count":16876322,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["c-plus-plus","cmake","game","go"],"created_at":"2024-07-31T03:01:31.071Z","updated_at":"2024-10-28T01:30:19.434Z","avatar_url":"https://github.com/griefly.png","language":"C++","funding_links":[],"categories":["C++"],"sub_categories":[],"readme":"Griefly\n===========\n\n[![Linux Build Status](https://travis-ci.org/griefly/griefly.svg?branch=master)](https://travis-ci.org/griefly/griefly)\n[![Windows Build Status](https://ci.appveyor.com/api/projects/status/github/griefly/griefly?branch=master\u0026svg=true)](https://ci.appveyor.com/project/kremius/griefly)\n[![Coverage Status](https://coveralls.io/repos/github/griefly/griefly/badge.svg?branch=master)](https://coveralls.io/github/griefly/griefly?branch=master)\n[![Join the chat at https://gitter.im/griefly/griefly](https://badges.gitter.im/kremius/karya-valya.svg)](https://gitter.im/griefly/griefly?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n\nIt is **Griefly: Yet Another Space Station Remake**.  \n[Roadmap](https://github.com/griefly/griefly/blob/master/documentation/Roadmap.md) may be interesting to look into.\n\nDependencies\n-------------\n1. Some C++14 compiler (it works at least with compiler from **Visual Studio 2015** and **g++**)\n2. Qt5.8+\n3. Python 3.5\n4. Golang 1.5+ (https://golang.org/dl/)\n5. Git\n6. CMake 3.*\n\nHow to build everything on Windows\n----------------------------------\n_If you have any issues during the build process please report them_   \n\nIt should be possible to build everything without Qt Creator, but the guide assumes that Qt Creator is used.  \n\n1. All tools and libs from the dependencies list should be available on your machine. Tools and libs should be present in `%PATH%`\n2. Open CMakeLists.txt in Qt Creator  \n   Open Project -\u003e Select CMakeLists.txt -\u003e Select build folder\n3. Run CMake with param `-DCMAKE_BUILD_TYPE=Release` for Release verison.\n4. Build the project.  \n   Client executables will appear in the `exec` folder, and the server executable will appear in the `griefly-server` folder.  \n   Client executables depend from various dlls, so it is needed to manually place them to the `exec` folder.\n\n**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.  \n\nHow to build everything on Linux\n--------------------------------\n\n1. 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`)\n2. `cd` into installation directory.\n3. `git clone https://github.com/griefly/griefly.git`\n4. `cd griefly`\n4. `./make.sh`. Built project will be placed under `exec` directory. Server will be\n   built in `gopath/src/griefly-server` directory.\n\n**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.  \n**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.  \n**Note:** There may be some issues with CMake 3.0.2, so try to update your CMake if issues appear.  \n\nHow to build everything on MacOS\n--------------------------------\n\n1. Install dependencies using brew. `brew install qt`\n2. Look at the tips in `make.sh` and adjust your environment accordingly.\n3. `./make.sh`. Build project will be placed under `exec` directory Server will be\n   built in `gopath/src/griefly-server` directory.\n\nHow to start server\n-------------------\n\nServer available in directory `gopath/src/griefly-server`. When hosting server,\nconsider following adjustments:\n\n1. Change password for admin user in db/auth.json. Passwords stored in plain\n   text now.\n2. When starting server, provide `-server-url` parameter. This parameter is an URL for asset server.\n   It should be either host address (when server exposed to internet directly) or external ip\n   (when running behind NAT). Server will bind on port, extracted from this url and\n   clients will use url to connect to server for map exchange.\n\nOther server options available in help: `griefly-server -h`\n\nHow to run game without launcher\n--------------------------------\n\nPass those command line parameters to `KVEngine` or `KVEngine.exe`:\n\nFirst (master) client:  \n`mapgen_name=\u003cpath_to_mapgen\u003e login=\u003cadmin login\u003e password=\u003cadmin password\u003e`  \nwhere `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`).  \nOther clients:  \n`login=Guest`\n\nYou can also specify game host by parameter `ip=game_host_address`. By default it connects to localhost.\n\nLauncher basically does same things, but in a more convenient for usual users way.\n\nCodestyle\n----------\nSee `documentation/CODESTYLE.md` file for C++ codestyle. Use default ones for Python and Go (PEP8 and Go Coding Style accordingly).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgriefly%2Fgriefly","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgriefly%2Fgriefly","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgriefly%2Fgriefly/lists"}