Skip to content

Commit

Permalink
docs: initial v1 specs guide
Browse files Browse the repository at this point in the history
  • Loading branch information
krypt0nn committed Jan 13, 2024
1 parent a3c0359 commit b6412e1
Show file tree
Hide file tree
Showing 4 changed files with 497 additions and 42 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
| [macOS launcher](https://github.com/3Shain/yet-another-anime-game-launcher) | Another launcher with special macOS-compatible components |
| [Releases page](https://github.com/an-anime-team/anime-games-launcher/releases) | Launcher releases list |
| [Changelog](CHANGELOG.md) | Launcher updates chronology |
| [Integration guide](GAMES_INTEGRATION.md) | Games integration standard |
| [Integration guide](repository/integrations) | Games integration standard |
| [Components repo](https://github.com/an-anime-team/components) | Repository with default wine and dxvk versions used in the launcher |
| [Integrations repo](https://github.com/an-anime-team/game-integrations) | Repository with default games integrations used in the launcher |

Expand Down
24 changes: 24 additions & 0 deletions repository/integrations/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Anime Games Launcher integrations guide

Hello comrade developers! The new universal launcher uses lua scripts to handle games support. Here you can find a guide to write your own integration script, and a formal specification.

- [v1 standard specification](V1_SPECIFICATION.md)
- [v1 standard guide](V1_GUIDE.md)

## Manifest file

```json
{
"manifest_version": "1",
"game": {
"name": "game-code-name",
"title": "Formal Game Name",
"developer": "Game Developer"
},
"script": {
"path": "integration.lua",
"version": "0.0.0",
"standard": "1"
}
}
```
Loading

0 comments on commit b6412e1

Please sign in to comment.