Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/milerius/nephtys

Nephtys Open Source MMORPG Written in C++17
https://github.com/milerius/nephtys

boost-asio cpp cpp-17 entt mmorpg mmorpg-game noesis noesisgui sfml sfml-game sqlite3

Last synced: 23 days ago
JSON representation

Nephtys Open Source MMORPG Written in C++17

Host: GitHub
URL: https://github.com/milerius/nephtys
Owner: Milerius
License: other
Created: 2019-03-25T20:45:45.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2019-10-21T09:43:03.000Z (about 5 years ago)
Last Synced: 2024-10-03T12:24:09.184Z (about 1 month ago)
Topics: boost-asio, cpp, cpp-17, entt, mmorpg, mmorpg-game, noesis, noesisgui, sfml, sfml-game, sqlite3
Language: C++
Homepage:
Size: 7.05 MB
Stars: 43
Watchers: 11
Forks: 4
Open Issues: 1
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE-OF-CONDUCT.md

Awesome Lists containing this project

README

# Nephtys

Nephtys is an open-source **MMORPG** based on ancient egypt written in modern C++.
Nephtys is a 2.5D isometric game with strategic and turn-based oriented battle system.

## Prerequisites

Below is the list of prerequisites to compile `Nephtys` on your machine:

- [Conan](https://conan.io/downloads.html) 1.14.1 minimum
- [CMake](https://cmake.org/download/) 3.12 minimum
- gcc-8 or clang-8 or msvc15-2017 minimum

## Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

### Add remotes

To be able to add the list of nephtys dependency remotes please type the following command:

conan config install .conan/remotes/

### Build

To build the project please follow the instructions below:

```bash
mkdir build ## bash or powershell
cd build ## bash or powershell
conan install --build missing ../.conan/linux ## osx or windows or linux
cmake --build . --config Release
```

### Installing

:construction:

## Running the tests

:construction:

## Deployment

:construction:

## Built With

- [SFML](https://www.sfml-dev.org/index-fr.php) - Game framework used
- [nlohmann::json](https://github.com/nlohmann/json) - Json framework used
- [EnTT](https://github.com/skypjack/entt) - ECS framework used.
- [doom::strong_type](https://github.com/doom/strong_type) - C++ strong type library
- [doom::meta](https://github.com/doom/meta) - C++ metaprogramming utilities
- [doctest](https://github.com/onqtam/doctest) - Testing framework used

## Code of Conduct

Before any contribution please read our [CODE OF CONDUCT](./CODE-OF-CONDUCT.md).

## Contributing

Please read [CONTRIBUTING.md](./CONTRIBUTING.md), contain the process for submitting pull requests to us.

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/milerius/nephtys/tags).

## Authors

- **Roman Sztergbaum** - _Co-Creator_ - [Milerius](https://github.com/Milerius)
- **Clément Doumergue** - _Co-Creator_ - [Doom](https://github.com/doom)
- **Arthur Cros** - _Co-Creator_ - [Riz-cros](https://github.com/Riz-cros)

See also the list of [contributors](./CONTRIBUTORS.md) who participated in this project.

## License

This work is licensed under a Creative Commons Attribution-NonCommercial 4.0 International License.

see the [LICENSE](./LICENSE.md) file for details.

## Acknowledgments

- Viktor Kirilov [onqtam](https://github.com/onqtam) for the awesome `doctest` framework.
- Michele Caini [skypjack](https://github.com/skypjack) for permanent help and explanations and `EnTT`.
- Ithare () blogger for awesome game design tutorial.

* * *

| Badges | |
| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Travis (Linux/Osx) | [![Build Status](https://travis-ci.org/Milerius/nephtys.svg?branch=master)](https://travis-ci.org/Milerius/nephtys) |
| AppVeyor | [![Build status](https://ci.appveyor.com/api/projects/status/52kj3es99ys9rrkq/branch/master?svg=true)](https://ci.appveyor.com/project/Milerius/nephtys/branch/master) |
| LGTM | [![Total alerts](https://img.shields.io/lgtm/alerts/g/Milerius/nephtys.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Milerius/nephtys/alerts/)
[![Language grade: C/C++](https://img.shields.io/lgtm/grade/cpp/g/Milerius/nephtys.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/Milerius/nephtys/context:cpp) |
| Codacy | [![Codacy Badge](https://api.codacy.com/project/badge/Grade/03467b03fbdf4454ba5b6cbac214813f)](https://www.codacy.com/app/Milerius/nephtys?utm_source=github.com&utm_medium=referral&utm_content=Milerius/nephtys&utm_campaign=Badge_Grade) |
| Issues | ![GitHub issues][issues_bdg] |
| License |
This work is licensed under a Creative Commons Attribution-NonCommercial 4.0 International License. |
| Report.CI (AppVeyor) | **AppVeyor VS15_2017_Win64_Dbg:** [![badge][apvr_dbg_win64_vs15_2017_bdg]][apvr_dbg_win64_vs15_2017_lk]
**AppVeyor VS15_2017_Win64_Release:** [![badge][apvr_rls_win64_vs15_2017_bdg]][apvr_rls_win64_vs15_2017_lk] |
| Report.CI (Travis Linux) | **g++-8-Dbg**: [![badge][tl_dbg_gcc_8_bdg]][tl_dbg_gcc_8_lk]
**g++-8-Dbg-ASAN**: [![badge][tl_dbg_gcc_8_asan_bdg]][tl_dbg_gcc_8_asan_lk]
**g++-8-Dbg-TSAN**: [![badge][tl_dbg_gcc_8_tsan_bdg]][tl_dbg_gcc_8_tsan_lk]
**g++-8-Dbg-UBSAN**: [![badge][tl_dbg_gcc_8_ubsan_bdg]][tl_dbg_gcc_8_ubsan_lk]
**g++-8-Dbg-Ninja**: [![badge][tl_dbg_gcc_8_ninja_bdg]][tl_dbg_gcc_8_ninja_lk]
**g++-8-Rls**: [![badge][tl_rls_gcc_8_bdg]][tl_rls_gcc_8_lk]
**g++-8-Rls-Ninja**: [![badge][tl_rls_gcc_8_ninja_bdg]][tl_rls_gcc_8_ninja_lk]
**clang-8-Rls**: [![badge][tl_rls_clang_8_bdg]][tl_rls_clang_8_lk]
**clang-8-Dbg**: [![badge][tl_dbg_clang_8_bdg]][tl_dbg_clang_8_lk]
**clang-8-Dbg-ASAN**: [![badge][tl_dbg_clang_8_asan_bdg]][tl_dbg_clang_8_asan_lk]
**clang-8-Dbg-TSAN**: [![badge][tl_dbg_clang_8_tsan_bdg]][tl_dbg_clang_8_tsan_lk]
**clang-8-Dbg-UBSAN**: [![badge][tl_dbg_clang_8_ubsan_bdg]][tl_dbg_clang_8_ubsan_lk] |
| Report.CI (Travis OSX) | **clang-8-Dbg**: [![badge][tosx_dbg_clang_8_bdg]][tosx_dbg_clang_8_lk]
**clang-8-Rls**: [![badge][tosx_rls_clang_8_bdg]][tosx_rls_clang_8_lk] |
| Coveralls (Coverage Linux) | [![Coverage Status][coverage_bdg]][coverage_lk] |
| CodeCov (Coverage OSX) | [![codecov](https://codecov.io/gh/Milerius/nephtys/branch/master/graph/badge.svg)](https://codecov.io/gh/Milerius/nephtys) |
| Codefactor | ![CodeFactor][code_factor_bdg] |
| Docs | [![Documentation Status][docs_bdg]][docs_lk] |
| Bintray Linux | [![Download][bt_linux_dl_lk]][bt_linux_dl] |
| Bintray OSX | [![Download](https://api.bintray.com/packages/milerius/nephtys-release/nephtys-osx/images/download.svg) ](https://bintray.com/milerius/nephtys-release/nephtys-osx/_latestVersion) |
| HitCount | [![HitCount](http://hits.dwyl.io/milerius/nephtys.svg)](http://hits.dwyl.io/milerius/nephtys) |
| Line of Code | [![](https://tokei.rs/b1/github/milerius/nephtys)](https://github.com/milerius/nephtys) |
| Conventional Commit | [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org) |

[issues_bdg]: https://img.shields.io/github/issues/milerius/nephtys.svg

[apvr_rls_win64_vs15_2017_lk]: https://report.ci/status/Milerius/nephtys?branch=master&build=appveyor%20Visual-Studio-15-2017-Win64-Release

[apvr_rls_win64_vs15_2017_bdg]: https://report.ci/status/Milerius/nephtys/badge.svg?branch=master&build=appveyor%20Visual-Studio-15-2017-Win64-Release

[apvr_dbg_win64_vs15_2017_lk]: https://report.ci/status/Milerius/nephtys?branch=master&build=appveyor%20Visual-Studio-15-2017-Win64-Debug

[apvr_dbg_win64_vs15_2017_bdg]: https://report.ci/status/Milerius/nephtys/badge.svg?branch=master&build=appveyor%20Visual-Studio-15-2017-Win64-Debug

[tl_dbg_clang_8_asan_lk]: https://report.ci/status/Milerius/nephtys?branch=master&build=travis-ci%20linux-clang-8-Debug-ASAN

[tl_dbg_clang_8_asan_bdg]: https://report.ci/status/Milerius/nephtys/badge.svg?branch=master&build=travis-ci%20linux-clang-8-Debug-ASAN

[tl_dbg_clang_8_ubsan_lk]: https://report.ci/status/Milerius/nephtys?branch=master&build=travis-ci%20linux-clang-8-Debug-UBSAN

[tl_dbg_clang_8_ubsan_bdg]: https://report.ci/status/Milerius/nephtys/badge.svg?branch=master&build=travis-ci%20linux-clang-8-Debug-UBSAN

[tl_dbg_clang_8_tsan_lk]: https://report.ci/status/Milerius/nephtys?branch=master&build=travis-ci%20linux-clang-8-Debug-TSAN

[tl_dbg_clang_8_tsan_bdg]: https://report.ci/status/Milerius/nephtys/badge.svg?branch=master&build=travis-ci%20linux-clang-8-Debug-TSAN

[tl_dbg_clang_8_lk]: https://report.ci/status/Milerius/nephtys?branch=master&build=travis-ci%20linux-clang-8-Debug

[tl_dbg_clang_8_bdg]: https://report.ci/status/Milerius/nephtys/badge.svg?branch=master&build=travis-ci%20linux-clang-8-Debug

[tl_rls_clang_8_lk]: https://report.ci/status/Milerius/nephtys?branch=master&build=travis-ci%20linux-clang-8-Release

[tl_rls_clang_8_bdg]: https://report.ci/status/Milerius/nephtys/badge.svg?branch=master&build=travis-ci%20linux-clang-8-Release

[tl_rls_gcc_8_ninja_lk]: https://report.ci/status/Milerius/nephtys?branch=master&build=travis-ci%20linux-gcc-8-Release-Ninja

[tl_rls_gcc_8_ninja_bdg]: https://report.ci/status/Milerius/nephtys/badge.svg?branch=master&build=travis-ci%20linux-gcc-8-Release-Ninja

[tl_rls_gcc_8_lk]: https://report.ci/status/Milerius/nephtys?branch=master&build=travis-ci%20linux-gcc-8-Release

[tl_rls_gcc_8_bdg]: https://report.ci/status/Milerius/nephtys/badge.svg?branch=master&build=travis-ci%20linux-gcc-8-Release

[tl_dbg_gcc_8_ninja_lk]: https://report.ci/status/Milerius/nephtys?branch=master&build=travis-ci%20linux-gcc-8-Debug-Ninja

[tl_dbg_gcc_8_ninja_bdg]: https://report.ci/status/Milerius/nephtys/badge.svg?branch=master&build=travis-ci%20linux-gcc-8-Debug-Ninja

[tl_dbg_gcc_8_ubsan_lk]: https://report.ci/status/Milerius/nephtys?branch=master&build=travis-ci%20linux-gcc-8-Debug-UBSAN

[tl_dbg_gcc_8_ubsan_bdg]: https://report.ci/status/Milerius/nephtys/badge.svg?branch=master&build=travis-ci%20linux-gcc-8-Debug-UBSAN

[tl_dbg_gcc_8_tsan_lk]: https://report.ci/status/Milerius/nephtys?branch=master&build=travis-ci%20linux-gcc-8-Debug-TSAN

[tl_dbg_gcc_8_tsan_bdg]: https://report.ci/status/Milerius/nephtys/badge.svg?branch=master&build=travis-ci%20linux-gcc-8-Debug-TSAN

[tl_dbg_gcc_8_asan_lk]: https://report.ci/status/Milerius/nephtys?branch=master&build=travis-ci%20linux-gcc-8-Debug-ASAN

[tl_dbg_gcc_8_asan_bdg]: https://report.ci/status/Milerius/nephtys/badge.svg?branch=master&build=travis-ci%20linux-gcc-8-Debug-ASAN

[tl_dbg_gcc_8_lk]: https://report.ci/status/Milerius/nephtys?branch=master&build=travis-ci%20linux-gcc-8-Debug

[tl_dbg_gcc_8_bdg]: https://report.ci/status/Milerius/nephtys/badge.svg?branch=master&build=travis-ci%20linux-gcc-8-Debug

[tosx_rls_clang_8_lk]: https://report.ci/status/Milerius/nephtys?branch=master&build=travis-ci%20osx-clang-8-Release

[tosx_rls_clang_8_bdg]: https://report.ci/status/Milerius/nephtys/badge.svg?branch=master&build=travis-ci%20osx-clang-8-Release

[tosx_dbg_clang_8_lk]: https://report.ci/status/Milerius/nephtys?branch=master&build=travis-ci%20osx-clang-8-Debug

[tosx_dbg_clang_8_bdg]: https://report.ci/status/Milerius/nephtys/badge.svg?branch=master&build=travis-ci%20osx-clang-8-Debug

[coverage_lk]: https://coveralls.io/github/Milerius/nephtys?branch=master

[coverage_bdg]: https://coveralls.io/repos/github/Milerius/nephtys/badge.svg?branch=master

[code_factor_bdg]: https://www.codefactor.io/repository/github/milerius/nephtys/badge?style=plastic

[docs_bdg]: https://readthedocs.org/projects/nephtys/badge/?version=latest

[docs_lk]: https://nephtys.readthedocs.io/en/latest/?badge=latest

[bt_linux_dl_lk]: https://api.bintray.com/packages/milerius/nephtys-release/nephtys-linux/images/download.svg

[bt_linux_dl]: https://bintray.com/milerius/nephtys-release/nephtys-linux/_latestVersion