This repository contains the documentation for webRcade (Feed-driven gaming).
The webЯcade Documentation consists of a User Guide, instructions specific to each Platform (OS, devices) supported by webЯcade, detailed information (button mappings, etc.) for the various Application Types (emulators, etc.), and guidance for developing your own Feeds.
The following steps are recommended for getting started with webЯcade:
- Review the User Guide in order to familiarize yourself with the webЯcade front-end.
- Read the documentation for the Platform (OS, device) you will be using with webЯcade to learn platform-specific details such as how to optimize the experience and how to connect gamepads.
- Review the documentation for each Application that is launched to determine its keyboard and gamepad mappings as well as any other application-specific notes (an application is the emulator or engine being used to play a particular game, etc.).
Any help is more than welcome here.
- Python
- mkdocs
- Material for mkdocs
- A code editor like Visual Studio Code
Run mkdocs serve while inside the project directory to locally serve the documentation.
It can be reached at http://127.0.0.1:8080/
While editing, we ask that you conform to the syntax standards of makrdownlint.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.