arianrhodsandlot/retroassembly

RetroAssembly

https://github.com/arianrhodsandlot/retroassembly

https://hub.docker.com/r/arianrhodsandlot/retroassembly

RetroAssembly is a web-based personal retro game collection cabinet that brings classic gaming consoles directly to your browser.

!https://raw.githubusercontent.com/arianrhodsandlot/retroassembly/refs/heads/main/public/assets/screenshots/library.jpeg

Features

• Relive memories from numerous retro gaming consoles in the browser. NES, SNES, Genesis, GameBoy, Arcade... See Supported Platforms below.
• See your game collection displayed with auto-detected beautiful box arts and covers.
• Save and synchronize your game at any point and resume later.
• Made a mistake? Some emulators allow you to rewind gameplay.
• Browse through platforms and your game library with an intuitive interface with spatial navigation , which means you can just use a keyboard or a gamepad to navigate between games.
• Enhance your gaming experience with beautiful visual effects with retro-style shaders.
• Play on the go, even without a physical gamepad, using our on-screen virtual controller.

Quick Start

Using Docker Compose

1. Make sure you have Docker and Docker Compose installed on your system.
2. Create a compose.yaml file:

   yaml
   services:
     retroassembly:
       image: arianrhodsandlot/retroassembly
       container_name: retroassembly
       ports: [8000:8000]
       volumes: [/path/to/your/data:/app/data]
       restart: unless-stopped
   

   Replace /path/to/your/data with the actual path where you want to store your game data, ROMs, and save states.
3. Run the service:

   sh
   docker-compose up -d
   

Using Docker CLI

1. Make sure you have Docker installed on your system.
2. Pull and run the https://hub.docker.com/r/arianrhodsandlot/retroassembly:

   sh
   docker run -d --name retroassembly -p 8000:8000 -v /path/to/your/data:/app/data arianrhodsandlot/retroassembly
   

   Replace /path/to/your/data with the actual path where you want to store your game data, ROMs, and save states. For example:

   sh
   docker run -d --name retroassembly -p 8000:8000 -v /srv/retroassembly:/app/data arianrhodsandlot/retroassembly
   

   You can also change the port 8000 to any other value you want.

Accessing Your Instance

1. Open your browser and navigate to http://yourhost:8000 (if the port 8000 is used in previous steps) to access your self-hosted RetroAssembly instance.
2. Create an account after clicking the "Library" button.
3. Upload your ROM files and start gaming!

Upgrade

To upgrade your RetroAssembly Docker container to the latest version while keeping your data:

Using Docker Compose

1. Pull the latest image:

sh
docker-compose pull

2. Recreate and start the service:

sh
docker-compose up -d

Your ROMs, save states, and settings will be preserved as long as the data volume is unchanged.

Using Docker CLI

1. Stop and remove the existing container (your data is safe if you mapped the /app/data volume):

sh
docker stop retroassembly
docker rm retroassembly

2. Pull the latest image:

sh
docker pull arianrhodsandlot/retroassembly

3. Start a new container with the same volume mapping:

sh
docker run -d --name retroassembly -p 8000:8000 -v /path/to/your/data:/app/data arianrhodsandlot/retroassembly

Replace /path/to/your/data with your actual data directory.

Links

• Website: [***]
• Demo: [***]
• GitHub: https://github.com/arianrhodsandlot/retroassembly
• : []

License

https://github.com/arianrhodsandlot/retroassembly/blob/main/license - see the https://github.com/arianrhodsandlot/retroassembly for details.