1
0
mirror of synced 2025-01-31 20:05:19 +01:00
lindbergh-loader/README.md

64 lines
4.7 KiB
Markdown
Raw Normal View History

2024-12-23 14:47:46 +00:00
[![Actions Status](https://github.com/lindbergh-loader/lindbergh-loader/actions/workflows/ci.yml/badge.svg)](https://github.com/lindbergh-loader/lindbergh-loader/actions)
2022-07-07 13:34:29 +01:00
2024-12-23 14:41:01 +00:00
# SEGA Lindbergh Emulator
2022-07-07 13:34:29 +01:00
2024-12-23 14:41:01 +00:00
This project emulates the SEGA Lindbergh, allowing games to run on modern Linux computers to be used as replacement hardware for broken Lindbergh systems in physical arcade machines. It supports both Intel and AMD CPUs as well as Intel, NVIDIA and AMD GPUs, surround sound audio, networking and JVS pass through.
2022-09-02 14:49:39 +01:00
2024-12-23 14:47:46 +00:00
If you'd like to support the development work of this emulator, see early development builds or get support from the authors please consider [becoming a patreon here](https://www.patreon.com/LindberghLoader).
2024-12-23 14:41:01 +00:00
## Building & Running
2022-07-19 13:55:52 +01:00
In order to build the loader you will need to install the following dependencies in a Linux environment. We recommend Ubuntu 22.04 LTS as default, but it may work in various configurations like WSL2, Debian, etc.
Please note other dependencies might be required to run games (see the [guide](docs/guide.md)).
2022-07-19 13:55:52 +01:00
2024-12-23 14:41:01 +00:00
```shell
2024-01-05 21:14:40 +00:00
sudo dpkg --add-architecture i386
sudo apt update
2024-12-23 14:41:01 +00:00
sudo apt install git build-essential gcc-multilib freeglut3-dev:i386 libsdl2-dev:i386 libfaudio-dev:i386
2024-03-03 22:17:03 +00:00
```
2024-12-23 14:41:01 +00:00
This emulator will need access to the input devices and serial devices on your computer. You should add your user account to the following groups and then _restart your computer_.
2024-02-29 12:14:47 +00:00
2024-12-23 14:41:01 +00:00
```shell
sudo usermod -a -G dialout,input $USER
2022-10-11 12:19:37 +01:00
```
2022-07-19 13:55:52 +01:00
2024-12-23 14:41:01 +00:00
Then you should clone the repository, change directory into it and run make.
2023-02-09 23:23:49 +00:00
2024-12-23 14:41:01 +00:00
```shell
2024-12-23 14:47:46 +00:00
git clone git@github.com:lindbergh-loader/lindbergh-loader.git
2024-12-23 14:41:01 +00:00
cd lindbergh-loader
make
2023-02-09 23:23:49 +00:00
```
You should then copy the contents of the build directory to your game directory and run `./lindbergh` for the game, or `./lindbergh -t` for test mode. Please note you might need to set the game executable as "executable" using `chmod +x`.
2022-07-07 13:34:29 +01:00
2024-12-23 14:41:01 +00:00
```shell
cp -a build/* /home/games/the-house-of-the-dead-4/disk0/elf/.
cd /home/games/the-house-of-the-dead-4/disk0/elf/.
2024-03-03 22:17:03 +00:00
./lindbergh
2022-07-07 13:34:29 +01:00
```
If you'd like to change game settings copy the [default configuration file](docs/lindbergh.conf) from the repository to your game directory.
2022-12-28 13:36:42 +00:00
2024-12-23 14:41:01 +00:00
```shell
cp build/docs/lindbergh.conf /home/games/the-house-of-the-dead-4/disk0/elf/.
nano lindbergh.conf
```
2022-12-28 13:20:45 +00:00
Please take a look at the configuration options, supported games and known issues in the [guide](docs/guide.md).
2023-02-09 23:23:49 +00:00
2024-12-23 14:41:01 +00:00
## License
2023-12-28 22:52:05 +00:00
2024-12-23 14:41:01 +00:00
<p xmlns:cc="http://creativecommons.org/ns#" xmlns:dct="http://purl.org/dc/terms/"><a property="dct:title" rel="cc:attributionURL" href="https://github.com/lindbergh-loader/">Lindbergh Loader</a> by <a rel="cc:attributionURL dct:creator" property="cc:attributionName" href="https://github.com/lindbergh-loader/">Lindbergh Loader Development Team</a> is licensed under <a href="https://creativecommons.org/licenses/by-nc-sa/4.0/?ref=chooser-v1" target="_blank" rel="license noopener noreferrer" style="display:inline-block;">Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International<img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/cc.svg?ref=chooser-v1" alt=""><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/by.svg?ref=chooser-v1" alt=""><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/nc.svg?ref=chooser-v1" alt=""><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/sa.svg?ref=chooser-v1" alt=""></a></p>
2022-12-28 21:04:21 +00:00
2024-12-23 15:38:00 +00:00
Our project is open source, and our primary goal is to preserve and maintain Lindbergh arcade machines, ensuring they continue to operate in arcades. We encourage individuals to use the information provided for their own open source projects and contribute to the development of the loader to improve it for the benefit of the community. However, we do not permit the use of any of our code in pay-to-play/subscription/commercial ventures without prior consent from the Lindbergh Loader Development Team. If we become aware of any such use, we reserve the right to take legal action.
2022-12-28 21:04:21 +00:00
2024-12-23 14:41:01 +00:00
## Thanks
2022-12-28 21:04:21 +00:00
2024-12-23 14:41:01 +00:00
This project has been built by referencing various earlier projects and would like to extend it's thanks to everyone that has contributed to the Lindbergh scene.
2024-03-03 22:17:03 +00:00
2024-12-23 14:41:01 +00:00
## Takedown Notices
2022-12-28 13:20:45 +00:00
2024-12-23 14:41:01 +00:00
The Lindbergh Loader Development Team respects intellectual property rights and is committed to ensuring that no copyrighted material is shared without proper authorization. If you believe that we are infringing on your intellectual property or have any concerns regarding our activities, please email us at bobby [at] dilley [dot] uk. We are more than happy to address any issues and discuss them further.