Skip to content

Commit d1e2f28

Browse files
icenine451icenine451
committed
Initial translation of retrodeck-api component manifest from legacy api_server.sh library
1 parent 8f91058 commit d1e2f28

1 file changed

Lines changed: 156 additions & 0 deletions

File tree

‎retrodeck-api/component_manifest.json‎

Lines changed: 156 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
{
2+
"retrodeck-api": {
3+
"name": "RetroDECK API",
4+
"description": "RetroDECK API",
5+
"core_framework_version": 1,
6+
"api_endpoints": {
7+
"get::retrodeck_settings": {
8+
"function": "api_get_retrodeck_settings",
9+
"description": "Get all RetroDECK settings as a JSON object"
10+
},
11+
"get::setting_value": {
12+
"function": "api_get_setting_value",
13+
"description": "Get a specific setting value from a configuration file",
14+
"required_fields": [
15+
"setting_file",
16+
"setting_name",
17+
"system_name"
18+
],
19+
"optional_fields": [
20+
"section_name"
21+
]
22+
},
23+
"get::component": {
24+
"function": "api_get_component",
25+
"description": "Get information about a specific component",
26+
"required_fields": [
27+
"component"
28+
]
29+
},
30+
"get::incompatible_presets": {
31+
"function": "api_get_incompatible_presets",
32+
"description": "Get the list of incompatible preset combinations"
33+
},
34+
"get::current_preset_state": {
35+
"function": "api_get_current_preset_state",
36+
"description": "Get the current state of a preset for a component",
37+
"required_fields": [
38+
"preset"
39+
],
40+
"optional_fields": [
41+
"component"
42+
]
43+
},
44+
"get::bios_file_status": {
45+
"function": "api_get_bios_file_status",
46+
"description": "Get the status of all BIOS files"
47+
},
48+
"get::multifile_game_structure": {
49+
"function": "api_get_multifile_game_structure",
50+
"description": "Get the multifile game directory structure"
51+
},
52+
"get::empty_rom_folders": {
53+
"function": "api_get_empty_rom_folders",
54+
"description": "Get the list of empty ROM folders"
55+
},
56+
"get::retrodeck_credits": {
57+
"function": "api_get_retrodeck_credits",
58+
"description": "Get RetroDECK project credits"
59+
},
60+
"get::retrodeck_versions": {
61+
"function": "api_get_retrodeck_versions",
62+
"description": "Get version information for RetroDECK and its components"
63+
},
64+
"get::retrodeck_changelog": {
65+
"function": "api_get_retrodeck_changelog",
66+
"description": "Get the changelog for a specific RetroDECK version",
67+
"required_fields": [
68+
"version"
69+
]
70+
},
71+
"get::compressible_games": {
72+
"function": "api_get_compressible_games",
73+
"description": "Get a list of games that can be compressed into a specific format",
74+
"required_fields": [
75+
"format"
76+
]
77+
},
78+
"set::setting_value": {
79+
"function": "api_set_setting_value",
80+
"description": "Set a specific setting value in a configuration file",
81+
"required_fields": [
82+
"setting_file",
83+
"setting_name",
84+
"setting_value",
85+
"system_name"
86+
],
87+
"optional_fields": [
88+
"section_name"
89+
]
90+
},
91+
"set::retrodeck_setting": {
92+
"function": "api_set_retrodeck_setting",
93+
"description": "Set a RetroDECK application setting",
94+
"required_fields": [
95+
"setting_name",
96+
"setting_value",
97+
"section_name"
98+
]
99+
},
100+
"set::preset_state": {
101+
"function": "api_set_preset_state",
102+
"description": "Enable or disable a preset for a component",
103+
"required_fields": [
104+
"component",
105+
"preset",
106+
"state"
107+
],
108+
"optional_fields": [
109+
"cheevos_username",
110+
"cheevos_token",
111+
"cheevos_login_timestamp"
112+
]
113+
},
114+
"do::compress_games": {
115+
"function": "api_do_compress_games",
116+
"description": "Compress games into specified formats",
117+
"required_fields": [
118+
"game_objects"
119+
],
120+
"optional_fields": [
121+
"post_compression_cleanup"
122+
]
123+
},
124+
"do::reset_component": {
125+
"function": "api_do_reset_component",
126+
"description": "Reset a component to its default configuration",
127+
"required_fields": [
128+
"component_name"
129+
]
130+
},
131+
"do::move_rd_directory": {
132+
"function": "api_do_move_retrodeck_directory",
133+
"description": "Move a RetroDECK directory to a new location",
134+
"required_fields": [
135+
"rd_dir",
136+
"dest"
137+
]
138+
},
139+
"do::install": {
140+
"function": "api_do_install_retrodeck_package",
141+
"description": "Install a RetroDECK package",
142+
"required_fields": [
143+
"package_name"
144+
]
145+
},
146+
"do::cheevos_login": {
147+
"function": "api_do_cheevos_login",
148+
"description": "Log in to RetroAchievements",
149+
"required_fields": [
150+
"username",
151+
"password"
152+
]
153+
}
154+
}
155+
}
156+
}

0 commit comments

Comments
 (0)