mirror of
https://github.com/pagefaultgames/pokerogue.git
synced 2025-12-15 06:15:20 +01:00
c695df777c
* Remove public folder to prepare for submodule * Add submodule and update licensing * Stop serving non-asset files during build * Update pull request template * Update CODEOWNERS * Add locales submodule * Update pull request template regarding locales * remove post-checkout lefthook in favor of git config * chore: add license info to new script * Update gh pages workflow * Apply kev's suggestions from code review Co-authored-by: NightKev <34855794+DayKev@users.noreply.github.com> * update assets
37 lines
2.9 KiB
Markdown
37 lines
2.9 KiB
Markdown
<!--
|
|
SPDX-FileCopyrightText: 2024-2025 Pagefault Games
|
|
|
|
SPDX-License-Identifier: CC-BY-NC-SA-4.0
|
|
-->
|
|
|
|
<div align="center"><picture><img src="./assets/images/logo.png" width="300" alt="PokéRogue"></picture>
|
|
|
|
[](https://discord.gg/pokerogue)
|
|
[](https://pagefaultgames.github.io/pokerogue/beta)
|
|
[](https://github.com/pagefaultgames/pokerogue/actions/workflows/tests.yml)
|
|
[](https://www.gnu.org/licenses/agpl-3.0)</div>
|
|
|
|
PokéRogue is a browser based Pokémon fangame heavily inspired by the roguelite genre. Battle endlessly while gathering stacking items, exploring many different biomes, fighting trainers, bosses, and more!
|
|
|
|
# Contributing
|
|
|
|
See [CONTRIBUTING.md](./CONTRIBUTING.md), this includes instructions on how to set up the game locally.
|
|
|
|
# 📝 Credits
|
|
|
|
> If this project contains assets you have produced and you do not see your name, **please** reach out, either [here on GitHub](https://github.com/pagefaultgames/pokerogue/issues/new) or via [Discord](https://discord.gg/pokerogue).
|
|
|
|
Thank you to all the wonderful people that have contributed to the PokéRogue project! You can find the credits [here](./CREDITS.md).
|
|
|
|
# License
|
|
|
|
This repository seeks to be REUSE compliant, so copyright and any licensing information is stored either in the file, or in an associated `REUSE.toml` file.
|
|
|
|
Using the [REUSE helper tool](https://github.com/fsfe/reuse-tool), you can run `reuse spdx` to get a full bill of materials.
|
|
|
|
- All source code belonging to the project, unless otherwise noted, is licensed under [AGPL-v3.0-only](LICENSES/AGPL-3.0-only.txt)
|
|
- All documentation (any markdown files), including this readme, as well as any documentation comments explicitly documenting source code, are also licensed under [CC-BY-NC-SA-4.0](LICENSES/CC-BY-NC-SA-4.0.txt)
|
|
- Auto-generated files produced by external tools or files of insigifnicant originality are not copyrighted and are licensed under [CC0-1.0](LICENSES/CC0-1.0.txt)
|
|
- To the extent that the assets we provide are [licensable and applicable](https://creativecommons.org/licenses/by-nc-sa/4.0/deed.en#ref-exception-or-limitation), they are licensed under [CC-BY-NC-SA-4.0](LICENSES/CC-BY-NC-SA-4.0.txt) unless otherwise noted. Exceptions can be found in associated REUSE.toml files. ⚠️ Files in `assets/` that are not explicitly licensed, as per the REUSE.toml, should be considered to have _no_ licensing / copyright information.
|
|
|
|
The full license information for each file can be found by utilizing REUSE's tooling, such as via `reuse spdx`. |