mirror of
https://github.com/RaySollium99/picodrive.git
synced 2025-09-04 23:07:46 -04:00
update README
This commit is contained in:
kub
parent
c12b126f06
commit
b4244cbb6d
1 changed files with 66 additions and 54 deletions
120
README.md
120
README.md
|
|
@ -1,33 +1,39 @@
|
||||||
This is yet another SEGA 8 bit and 16 bit console emulator for emulating most
|
This is yet another SEGA 8 bit and 16 bit console emulator.
|
||||||
of the hardware SEGA has published up to and including the 32X.
|
|
||||||
|
|
||||||
|
It can run games developed for most consumer hardware released
|
||||||
|
by SEGA, up to and including the 32X:
|
||||||
|
- **16 bit systems:** Mega Drive/Genesis, Sega/Mega CD, 32X, Pico
|
||||||
|
- **8 bit systems**: SG-1000, SC-3000, Master System/Mark III, Game Gear
|
||||||
|
|
||||||
PicoDrive was originally written having ARM-based handheld devices
|
PicoDrive was originally created with ARM-based handheld devices
|
||||||
in mind, but later had got various improvements for other architectures
|
in mind, but later received various cross-platform improvements
|
||||||
too, like SH2 recompilers for MIPS (mips32r2), ARM64 (armv8), RISC-V (RV64IM)
|
such as SH2 recompilers for MIPS (mips32r2), ARM64 (armv8), RISC-V (RV64IM)
|
||||||
and PowerPC (G4/2.03).
|
and PowerPC (G4/2.03).
|
||||||
|
|
||||||
PicoDrive was the first emulator ever to properly emulate Virtua Racing and
|
PicoDrive was the first software to properly emulate Virtua Racing and
|
||||||
its SVP chip.
|
its SVP chip.
|
||||||
|
|
||||||
Currently the main development happens in the
|
At present, most development activity occurs in
|
||||||
[irixxxx's fork](https://github.com/irixxxx/picodrive),
|
[irixxxx's fork](https://github.com/irixxxx/picodrive);
|
||||||
[notaz's repo](https://github.com/notaz/picodrive) isn't updated as much.
|
[notaz's repo](https://github.com/notaz/picodrive) is updated less frequently.
|
||||||
|
|
||||||
|
### Sega Pico and Storyware Pages
|
||||||
|
|
||||||
### gallery
|
PicoDrive can use Storyware pages and pad overlays in png format in the same
|
||||||
|
directory as the cartridge image. The selected page is displayed automatically
|
||||||
|
if the pen is used on the storyware or pad. Details about how to correctly name
|
||||||
|
the pages can be found in the *How to run Sega Pico games* section in
|
||||||
|
`platform/base_readme.txt`.
|
||||||
|
|
||||||
|
### Gallery
|
||||||
|
|
||||||
Some images of demos and homebrew software:
|
Some images of demos and homebrew software:
|
||||||
|
|
||||||
**16 bit systems**: Mega Drive/Genesis, Sega/Mega CD, 32X, Pico.
|
|
||||||
|
|
||||||
|  |  |  |
|
|  |  |  |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
| [_MegaDrive: Titan Overdrive 2_](https://demozoo.org/productions/170767/) | [_MegaCD: RaycastDemo_](https://github.com/matteusbeus/RaycastDemo) | [_32X: OpenLara_](https://github.com/XProger/OpenLara/releases) |
|
| [_MegaDrive: Titan Overdrive 2_](https://demozoo.org/productions/170767/) | [_MegaCD: RaycastDemo_](https://github.com/matteusbeus/RaycastDemo) | [_32X: OpenLara_](https://github.com/XProger/OpenLara/releases) |
|
||||||
||||
|
||||
|
||||||
| | [_MegaDrive: DMA David_](http://www.mode5.net/DMA_David.html) | [_32X: Doom Resurrection_](https://archive.org/details/doom-32x-all-versions) |
|
| [_MegaDrive: Titan Overdrive 2_](https://www.pouet.net/prod.php?which=69648) | [_MegaDrive: DMA David_](http://www.mode5.net/DMA_David.html) | [_32X: Doom Resurrection_](https://archive.org/details/doom-32x-all-versions) |
|
||||||
|
|
||||||
**8 bit systems**: SG-1000, SC-3000, Master System/Mark III, Game Gear.
|
|
||||||
|
|
||||||
|  |  |  |
|
|  |  |  |
|
||||||
| --- | --- | --- |
|
| --- | --- | --- |
|
||||||
|
|
@ -35,62 +41,68 @@ Some images of demos and homebrew software:
|
||||||
|  |  |  |
|
|  |  |  |
|
||||||
| [_SG-1000: Nyan Cat_](https://www.smspower.org/Homebrew/NyanCat-SG) | [_MS: Anguna the Prison Dungeon_](https://www.smspower.org/Homebrew/AngunaThePrisonDungeon-SMS) | [_GameGear: Turrican_](https://www.smspower.org/Homebrew/GGTurrican-GG) |
|
| [_SG-1000: Nyan Cat_](https://www.smspower.org/Homebrew/NyanCat-SG) | [_MS: Anguna the Prison Dungeon_](https://www.smspower.org/Homebrew/AngunaThePrisonDungeon-SMS) | [_GameGear: Turrican_](https://www.smspower.org/Homebrew/GGTurrican-GG) |
|
||||||
|
|
||||||
|
### Compiling
|
||||||
|
|
||||||
### compiling
|
For platforms where release builds are provided, the simplest method is to
|
||||||
|
use the release script `tools/release.sh`. See the script itself for details.
|
||||||
|
To create platform builds run the command:
|
||||||
|
|
||||||
For platforms for which release builds are supplied the most easy way is to
|
```
|
||||||
use the release script in tools/release.sh. See the release script for details.
|
tools/release.sh [version] [platforms...]
|
||||||
To make a platform build use
|
```
|
||||||
|
|
||||||
> tools/release.sh [version] [platforms...]
|
This will generate a file for each platform in the `release-[version]` directory.
|
||||||
|
A list of supported platforms can be found in the release script.
|
||||||
|
|
||||||
This will deliver a file for each platform in a the release-[version] directory.
|
These commands should create an executable for a unixoid platform not included in the list:
|
||||||
A list of platforms is in the release script.
|
|
||||||
|
|
||||||
If you want to build an executable for a unixoid platform not listed in the
|
```
|
||||||
platform list, try using
|
configure --platform=generic
|
||||||
|
make
|
||||||
|
```
|
||||||
|
|
||||||
> configure --platform=generic
|
To compile PicoDrive as a libretro core, use this command:
|
||||||
|
|
||||||
If DRC is available for the platform, it should be enabled automatically.
|
```
|
||||||
For gp2x, wiz, and caanoo you may need to compile libpng first.
|
make -f Makefile.libretro
|
||||||
|
```
|
||||||
|
|
||||||
After configure, compile with
|
### Helix MP3 decoder for ARM
|
||||||
|
|
||||||
> make
|
|
||||||
|
|
||||||
|
|
||||||
### helix MP3 decoder for ARM
|
|
||||||
|
|
||||||
For 32 bit ARM platforms, the optimized helix MP3 decoder can be used to play
|
For 32 bit ARM platforms, the optimized helix MP3 decoder can be used to play
|
||||||
MP3 audio files with CD games. The helix source files are however not supplied
|
MP3 audio files with CD games. Due to licensing issues, the helix source files
|
||||||
due to licensing issues. If you have legally obtained the sources, put them in
|
cannot be provided here; if you have obtained the sources legally, place them in
|
||||||
the platform/common/helix directory.
|
the `platform/common/helix` directory.
|
||||||
|
|
||||||
To compile the helix sources, set CROSS_COMPILE to your cross compiler prefix
|
To compile the helix sources:
|
||||||
(e.g. arm-linux-gnueabi-) and LIBGCC to your cross compiler's libgcc.a
|
|
||||||
(e.g. /usr/lib/gcc-cross/arm-linux-gnueabi/4.7/libgcc.a), and compile with
|
|
||||||
|
|
||||||
> make -C platform/common/helix CROSS_COMPILE=$CROSS_COMPILE LIBGCC=$LIBGCC
|
- Set the environment variable `CROSS_COMPILE` to your cross compiler prefix
|
||||||
|
(e.g. `arm-linux-gnueabi-`)
|
||||||
|
- Set the environment variable `LIBGCC` to your cross compiler's `libgcc.a`
|
||||||
|
(e.g. `/usr/lib/gcc-cross/arm-linux-gnueabi/4.7/libgcc.a`)
|
||||||
|
- Run the command:
|
||||||
|
```
|
||||||
|
make -C platform/common/helix CROSS_COMPILE=$CROSS_COMPILE LIBGCC=$LIBGCC
|
||||||
|
```
|
||||||
|
- Copy the resulting shared library named `${CROSS_COMPILE}helix_mp3.so` as
|
||||||
|
`libhelix.so` to the directory containing the PicoDrive binary on the target device.
|
||||||
|
|
||||||
This will result in a shared library named ${CROSS_COMPILE}helix_mp3.so. Copy
|
In addition, helix support must be enabled in PicoDrive itself by compiling with:
|
||||||
this as libhelix.so to where the PicoDrive binary is on the target device.
|
|
||||||
|
|
||||||
|
```
|
||||||
|
make PLATFORM_MP3=1
|
||||||
|
```
|
||||||
|
|
||||||
Also, the support for helix must be enabled in PicoDrive by compiling with
|
This switch is enabled automatically for Gamepark Holdings devices (`gp2x`,
|
||||||
|
`caanoo` and `wiz`). Without installing `libhelix.so`, these devices will not play
|
||||||
> make PLATFORM_MP3=1
|
|
||||||
|
|
||||||
This switch is automatically enabled for Gamepark Holdings devices (gp2x,
|
|
||||||
caanoo and wiz). Without installing libhelix.so those devices will not play
|
|
||||||
MP3 audio.
|
MP3 audio.
|
||||||
|
|
||||||
|
### Installing
|
||||||
|
|
||||||
### installing
|
The release script produces packages or zip archives which have to be installed
|
||||||
|
manually on the target device. Usually this involves unpacking the archive or
|
||||||
|
copying the package to a directory on either the internal device storage or an
|
||||||
|
SD card. Device-specific instructions can be found on the internet.
|
||||||
|
|
||||||
The release scripts produces zip files which need to be installed on the
|
|
||||||
target device manually. Usually that means unpacking the file to some
|
|
||||||
directory on the device storage or on an SD card. See device specific
|
|
||||||
descriptions on the net.
|
|
||||||
|
|
||||||
Send bug reports, fixes etc to <derkub@gmail.com>
|
Send bug reports, fixes etc. to <derkub@gmail.com>
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue