libretro/docs
1
0
Fork 0
mirror of https://github.com/libretro/docs.git synced 2024-11-27 10:40:28 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

refactor RA 'getting started' entries in TOC

Browse Source
This commit is contained in:
Mark W. Kidd 2019-03-21 11:04:01 -04:00
parent d1d595acd3
commit a287b74d37
6 changed files with 112 additions and 123 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

0
docs/guides/msvc-runtime-versions.md → docs/development/retroarch/compilation/msvc-runtime-versions.md
View File

110
docs/guides/install-windows.md
View File

@ -1,9 +1,7 @@
# Downloading, Installing and Updating RetroArch
# Getting Started with RetroArch: Windows 7 and Later
## Microsoft Windows
### Downloading
## Downloading
First decide if you want a stable release or a nightly.
@ -18,11 +16,11 @@ Both options provide you with the lastest RetroArch, the only difference is that
- It doesn't need users to guess random locations for configurations files
- It's easy to update by just replacing files
### Installing
## Installing
If you pick the 7z archive package, extract it in a folder that doesn't require administrator permissions such as *C:\Users\yourusername\RetroArch*. Don't extract it to *Program Files* or your Windows folder.
### Updating
## Updating
You can update the installation by downloading the latest **20XX-XX-XX-RetroArch.7z** package and overwriting the executable.
@ -30,3 +28,103 @@ If you pick the installer package we recommend to use the default location, foll
!!! Warning
If you were running a stable release prior to 1.4.0. you will need to update the system libraries. You can do so by downloading the full **RetroArch.7z** package or **redist.7z** from the download locations.
## Starting RetroArch
On the first run you will be greeted by this screen:
![Screenshot](/image/retroarch/xmb/first_run.png)
From here you can launch content, change settings and build up your content collection.
## Keyboard Controls
The RetroArch user interface is designed with gamepad navigation in mind but it also features robust keyboard and mouse support. Learn more about keyboard input at [RetroArch Keyboard Controls](https://buildbot.libretro.com/.docs/guides/retroarch-keyboard-controls/).
## Gamepad Controls
XINPUT controllers should work out of the box. If the controller can be autoconfigured the OSD will inform you of the autoconfiguration event. We also include autoconf profiles for many popular controllers. If your controller doesn't auto configure you can follow this procedure:
![Screenshot](/image/retroarch/xmb/autoconf.gif)
- Navigate to **Settings**
- Navigate to **Input**
- Navigate to **Input User 1 Binds**
- Select **User 1 Bind All**
- Press the buttons as required
!!! tip
If you have several different controller types you may want to use the **User 1 Save Autoconfig** followed by **User 1 Bind Default All** options after binding in order to achieve hotplug functionality
### Directory Configuration
Configuring directories is an important aspect to get the best RetroArch experience possible.
To configure the directories follow these steps:
- Navigate to **Settings**
- Navigate to **Directories**
- Select the directory you want to changed
- Navigate to the desired location
You should always configure the following paths:
- System Directory for *system files*
- Savefile Directory for *save files*
- Savestate Directory *save state files*
- Browser Directory for *your content*
!!! tip
The **Browser Directory** is used as a startup location which allows easy access to your content library.
### Installing Cores
RetroArch requires cores to run any content. You can download cores directly from RetroArch's interface by following this procedure:
![Screenshot](/image/retroarch/xmb/core_updater.gif)
- Navigate to **Online Updater**
- Navigate to **Select Core Updater**
- Select the core you want to download
### Running Content
After you have installed one or more cores you can run your content following this procedure:
- Navigate to **Load Content**
- Browse to the folder that contains the content you want to run
- Select the content that you want to run
- If you have more than one compatible core you will be asked to select the core you want to use for that purpose
![Screenshot](/image/retroarch/xmb/run_content.gif)
!!! tip
By default loading content will trigger a content scan. If your content matches with any of our databases it will be added to a playlist for easy access. You can find the playlists by navigating to the right of the main menu.
!!! tip
Every content you launch is added to a history playlist that you can use to load it again quickly at any time
## Glossary
#### frontend
A frontend is a program designed to run libretro cores such as Kodi's RetroPlayer, RetroArch, Phoenix, Minir
#### core
A core is a program that has been ported to the libretro API and runs inside a libretro frontend
#### content
Content can be a game, an image, a video, an audio file that is executed by a core. In most cases contents are the ROMs of an emulated platform
#### retropad
RetroPad is libretro’s input abstraction controller, it’s the interface between the physical controller and the core inputs
#### save files
Save files are saves that are made from within a game, usually cross platform and should work across emulators in most cases
#### save states
Save states are snapshots of the content menory at a particular moment, these are not always cross platform and most certainly won’t work on a different emulator that the one used to create them
#### system files
Additional files that might or not be part of the romset that might be needed to get some content to work (usually referred to by the BIOS term)
#### autoconf
A configuration file that has button definitions for a particular gamepad

2
docs/guides/overrides.md
View File

@ -8,7 +8,7 @@ There are various and comprehensive ways to save customized settings within the
- A standalone file also saves the Option settings for all cores that support them. The settings in this file can be overridden on a per game basis.
!!! tip
Please read the [Getting Started](windows.md) guide.
Please read the [Getting Started](install-windows.md) guide.
## Hierarchy

5
docs/guides/welcome-getting-started.md
View File

@ -1,5 +0,0 @@
# Getting Started: Welcome
## Welcome to the official RetroArch getting started guide!
The purpose of this guide is to teach someone who isn't familiar with RetroArch, how to install, configure and run games.

102
docs/guides/windows.md
View File

@ -1,102 +0,0 @@
# Getting Started with RetroArch
## Starting RetroArch
On the first run you will be greeted by this screen:
![Screenshot](/image/retroarch/xmb/first_run.png)
From here you can launch content, change settings and build up your content collection.
## Keyboard Controls
The RetroArch user interface is designed with gamepad navigation in mind but it also features robust keyboard and mouse support. Learn more about keyboard input at [RetroArch Keyboard Controls](https://buildbot.libretro.com/.docs/guides/retroarch-keyboard-controls/).
## Gamepad Controls
XINPUT controllers should work out of the box. If the controller can be autoconfigured the OSD will inform you of the autoconfiguration event. We also include autoconf profiles for many popular controllers. If your controller doesn't auto configure you can follow this procedure:
![Screenshot](/image/retroarch/xmb/autoconf.gif)
- Navigate to **Settings**
- Navigate to **Input**
- Navigate to **Input User 1 Binds**
- Select **User 1 Bind All**
- Press the buttons as required
!!! tip
If you have several different controller types you may want to use the **User 1 Save Autoconfig** followed by **User 1 Bind Default All** options after binding in order to achieve hotplug functionality
### Directory Configuration
Configuring directories is an important aspect to get the best RetroArch experience possible.
To configure the directories follow these steps:
- Navigate to **Settings**
- Navigate to **Directories**
- Select the directory you want to changed
- Navigate to the desired location
You should always configure the following paths:
- System Directory for *system files*
- Savefile Directory for *save files*
- Savestate Directory *save state files*
- Browser Directory for *your content*
!!! tip
The **Browser Directory** is used as a startup location which allows easy access to your content library.
### Installing Cores
RetroArch requires cores to run any content. You can download cores directly from RetroArch's interface by following this procedure:
![Screenshot](/image/retroarch/xmb/core_updater.gif)
- Navigate to **Online Updater**
- Navigate to **Select Core Updater**
- Select the core you want to download
### Running Content
After you have installed one or more cores you can run your content following this procedure:
- Navigate to **Load Content**
- Browse to the folder that contains the content you want to run
- Select the content that you want to run
- If you have more than one compatible core you will be asked to select the core you want to use for that purpose
![Screenshot](/image/retroarch/xmb/run_content.gif)
!!! tip
By default loading content will trigger a content scan. If your content matches with any of our databases it will be added to a playlist for easy access. You can find the playlists by navigating to the right of the main menu.
!!! tip
Every content you launch is added to a history playlist that you can use to load it again quickly at any time
## Glossary
#### frontend
A frontend is a program designed to run libretro cores such as Kodi's RetroPlayer, RetroArch, Phoenix, Minir
#### core
A core is a program that has been ported to the libretro API and runs inside a libretro frontend
#### content
Content can be a game, an image, a video, an audio file that is executed by a core. In most cases contents are the ROMs of an emulated platform
#### retropad
RetroPad is libretro’s input abstraction controller, it’s the interface between the physical controller and the core inputs
#### save files
Save files are saves that are made from within a game, usually cross platform and should work across emulators in most cases
#### save states
Save states are snapshots of the content menory at a particular moment, these are not always cross platform and most certainly won’t work on a different emulator that the one used to create them
#### system files
Additional files that might or not be part of the romset that might be needed to get some content to work (usually referred to by the BIOS term)
#### autoconf
A configuration file that has button definitions for a particular gamepad

16
mkdocs.yml
View File

@ -6,14 +6,12 @@ edit_uri: 'edit/master/docs'
nav:
- 'About': 'index.md'
- 'For Users':
- 'RetroArch: Downloading, Installing, and Updating':
- 'RetroArch: Getting Started':
- 'Windows': 'guides/install-windows.md'
- 'MSVC Runtime Compatibility': 'guides/msvc-runtime-versions.md'
- 'GNU/Linux': 'guides/install-gnu.md'
- 'iOS/tvOS': 'guides/install-ios.md'
- 'Nintendo Switch': 'guides/install-libnx.md'
- 'RetroArch: Getting Started':
- 'Welcome': 'guides/welcome-getting-started.md'
- 'RetroArch: User Guides':
- 'User Interface': 'guides/navigating.md'
- 'Input and Controls': 'guides/input-and-controls.md'
- 'Joypad Auto-Configuration': 'guides/joypad-autoconfiguration.md'
@ -26,7 +24,6 @@ nav:
- 'Generating Logs': 'guides/generating-retroarch-logs.md'
- 'Troubleshooting': 'guides/troubleshooting-retroarch.md'
- 'Command-Line Interface (CLI)': 'guides/cli-intro.md'
- 'RetroArch: Quick Guide - Windows': 'guides/windows.md'
- 'RetroArch: Feature-Specific':
- 'Cheat/Rumble Codes': 'guides/cheat-codes.md'
- 'Input and Joypad Drivers': 'guides/input-joypad-drivers.md'
@ -259,16 +256,17 @@ nav:
- 'Haiku': 'development/retroarch/compilation/haiku.md'
- 'Microsoft':
- 'Windows 7 and later (MSYS2)': 'development/retroarch/compilation/windows.md'
- Windows XP and later (MSVC2010):
- 'MSVC Compatibility Guide': 'development/retroarch/compilation/msvc-runtime-versions.md'
- 'Windows XP and later (MSVC2010)':
- 'MSVC Commandline': 'development/retroarch/compilation/windowsXP-msvc-cmdline.md'
- 'MSVC IDE': 'development/retroarch/compilation/windowsXP.md'
- Windows 2000 and later (MSVC2008):
- 'Windows 2000 and later (MSVC2008)':
- 'MSVC Commandline': 'development/retroarch/compilation/windows2000-msvc-cmdline.md'
- 'MSVC IDE': 'development/retroarch/compilation/windows2000.md'
- Windows 98SE/ME/2000 (MSVC2005):
- 'Windows 98SE/ME/2000 (MSVC2005)':
- 'MSVC Commandline': 'development/retroarch/compilation/windows98-msvc-cmdline.md'
- 'MSVC IDE': 'development/retroarch/compilation/windows98.md'
- Windows 95/98/NT4 (MSVC2003):
- 'Windows 95/98/NT4 (MSVC2003)':
- 'MSVC Commandline': 'development/retroarch/compilation/windows95-msvc-cmdline.md'
- 'Windows NT3.51 (MSVC6)':
- 'MSVC Commandline': 'development/retroarch/compilation/windowsNT351-msvc-cmdline.md'