diff --git a/README.md b/README.md index 6dbc41e1..3c1a6f96 100644 --- a/README.md +++ b/README.md @@ -5,44 +5,29 @@ This is the source code for Duelyst, a digital collectible card game and turn-based strategy hybrid developed by Counterplay Games and released in 2016. -## Production Deployment +## Running the Game Locally -Work is underway to deploy OpenDuelyst as "Duelyst Classic": a version of the -game exactly as it was in v1.96.17, before the servers were shut down. This is -being tracked in [issue #3](https://github.com/open-duelyst/duelyst/issues/3). +If you'd like to run the game locally or contribute to OpenDuelyst, check out +our [Documentation](docs/README.md), especially the [Roadmap](docs/ROADMAP.md) +and [Contributor Guide](docs/CONTRIBUTING.md). -## Staging Deployment - -The staging deployment is up and running at https://staging.duelyst.org. Both -single-player and multi-player games are available. +You can also join the OpenDuelyst developer Discord server +[here](https://discord.gg/HhUWfZ9cxe). This Discord server is focused on the +development of OpenDuelyst, and has channels for frontend, backend, and +infrastructure discussions, but it is open for anyone to join. ## Downloading the Desktop Clients Desktop clients for Windows, Mac, and Linux can be downloaded on the -[Releases](https://github.com/open-duelyst/duelyst/releases) page. - -Desktop clients currently use the staging environment. They'll use the -production environment once it's available. +[Releases](https://github.com/open-duelyst/duelyst/releases) page. They can be +used against your local environment. ## Playing on Android or iOS -We have basic support for playing on mobile web currently. From your phone's -browser, head to https://staging.duelyst.org to try it out. - -To hide the status/navigation bar in Chrome or Safari, open the game and select -"Add to Home Screen". When you open the game from the home screen, the status -bar will be hidden. - -## Contributing to OpenDuelyst - -If you'd like to contribute to OpenDuelyst, check out our -[Documentation](docs/README.md), especially the [Roadmap](docs/ROADMAP.md) and -[Contributor Guide](docs/CONTRIBUTING.md). - -You can also join the OpenDuelyst developer Discord server -[here](https://discord.gg/HhUWfZ9cxe). This Discord server is focused on the -development of OpenDuelyst, and has channels for frontend, backend, and -infrastructure discussions, but it is open for anyone to join. +We have basic support for playing on mobile web currently. To hide the +status/navigation bar in Chrome or Safari, open the game and select "Add to +Home Screen". When you open the game from the home screen, the status bar will +be hidden. ## Filing Issues and Reporting Bugs diff --git a/docs/ROADMAP.md b/docs/ROADMAP.md index b186cd6b..6405edb2 100644 --- a/docs/ROADMAP.md +++ b/docs/ROADMAP.md @@ -4,24 +4,19 @@ - OpenDuelyst will be free indefinitely, with no form of monetization. The code supporting payment processing has already been disabled or removed. -- We aim to preserve the original game experience of building a collection - while greatly accelerating card acquisition. As a result, all users receive - 2,500 Gold and 50,000 Spirit after logging in, which gives plenty of - resources to start building decks. The costs of purchasing Orbs (packs) and - crafting cards has been reduced by 50%, and quest rewards have been tripled. - Creating new content or making balance changes are not goals of this project. Instead, we aim to provide a well-maintained reference implementation and reference deployment of the game as it existed before the shutdown in 2020. - We will build clients for web (including mobile web) and desktop. - We would like to provide native mod support for modified art, game rules, cards, etc., enabling users to tweak the existing codebase without needing - to fork and heavily modify the project. + to heavily modify the project. -## Project Timeline +## Potential Work Areas -As of October 2022, most of the highest-priority issues, such as making the -game functional, building clients for our target platforms, and creating -automation and documentation for the project, are already complete. +Most high-priority issues, such as making the game functional, building clients +for our target platforms, and creating automation and documentation for the +project, are already complete. We are currently focused on contributor onboarding. Issues are tagged as `frontend`, `backend`, or `infrastructure` to make it easier to find work which @@ -33,14 +28,10 @@ issue, but we have some rough prioritization assigned to issues: - P2 issues involve minor end-user impact, such as visual or text bugs. - P3 issues involve minor developer impact, such as code cleanup. -For November 2022 and beyond, we have a few high-priority objectives: +Here are some examples of potential improvements: - Better mobile support, including packaging Android and iOS apps and improvements to UI scaling - Creating new achievements and quests - Creating new daily challenges and puzzles - Implementing a password reset flow (using tokens rather than email) - -At some point, we plan to provision a production environment in AWS for a more -"official" launch of the game. In the meantime, we are using the staging -environment as a publicly-available deployment for web and desktop clients.