Skip to content

Latest commit

 

History

History
89 lines (59 loc) · 3.83 KB

readme.md

File metadata and controls

89 lines (59 loc) · 3.83 KB
Raw

jc141 Setup Guide

Haven't installed GNU/Linux yet? check out EndeavourOS.

Suggestions for any changes to this repo are welcome on Matrix .

Supported GNU/Linux Distributions

Please click the following links to take you how to setup on your GNU/Linux distribution. If your distribution isn't here please check the Unsupported Distributions area.

  • Arch including: Endeavour OS, Arco, Artix, Manjaro and others
  • Debian including: Nitrux, Sparky Rolling and Siduction
  • Fedora including: Rawhide and Silverblue
  • OpenSUSE Tumbleweed

Unsupported Distributions

Unfortunately we are a voluntary group and have very limited resources at our disposal, we do this for fun. This means that we don't have the resources to support every single GNU/Linux distribution or GNU/Linux distributions that are more prone to errors.

Please feel free to try the release with whatever instructions more closely match your own system. For example if you use "Apt" as a package manager please try Debian. Otherwise we encourage you to switch to a distribution we do support.

Specifically we do not support:

  • Ubuntu (which is malware) including any derivatives e.g. Linux Mint or POP OS.
  • Packages are frequently out of date or conflicting.

Hardware Support

Not all hardware will run our releases. Please ensure your hardware meets the following specifications:

  • GPU/APU

    • Must have Vulkan support. Without it many releases simply will not run.

  • CPU

    • Should be at least an Intel i3 or equivalent.

  • RAM

    • Should be at least 8GB.

  • HDD/SSD

    • Should be up to modern standards. The Dwarfs mounting system is demanding.

  • SteamDeck support on Arch

How to Run the Game

Open up a terminal and then run the following commands. Please edit where appropriate.

bash /Path/to/Game/start.{n/w/e-w/n-w}.sh

Please check the script for the exact name, of course you can navigate to the directory and run the command there, negating the /Path/to/Game.

Troubleshooting

If for whatever you have a problem running the game please consider the following command to help with debugging.

DBG=1 bash /Path/to/Game/start.{n/w/e-w/n-w}.sh

This will produce output that will help us diagnose the problem. please also ensure you have the start.{n/we-w/n-w}.sh to hand.

Operating Dwarfs

Should your game exit in an inappropriate fashion or you would like to extract, there are a number of built-in commands to help you.

bash settings.sh <COMMAND>

Available Commands
  extract-dwarfs
  unmount-dwarfs
  mount-dwarfs
  delete-dwarfs
  compress-to-dwarfs

Modding Games with Dwarfs

Modding games with Dwarfs is somewhat different from the normal process, please follow the instructions here if you wish to add mods to your game.

Adding a mod is supported through using the groot-rw directory. Before mounting, any files included in it will go above the mounted image and override any of the files. The path required for the mod may need to be created manually.

The groot-rw directory only exists after the first run of mounted games. However, the directory can be created manually and content can be added without running.

Note: Games which are extracted do not require this method.

Additional Information

All releases are tested on an either Arch Linux or EndeavourOS using either an EXT4, BTRFS or XFS filesystem.

Window Managers are known to have more issues related to displaying, including freezing and crashing in rare cases.

GUI Libary

If you would like a GUI library for your games, see launchers page.