Skip to content

Nicer README #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
qqii wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Nicer README #30

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 31 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,35 @@
# ExpandedMagnorbs
# [ExpandedMagnorbs](https://steamcommunity.com/sharedfiles/filedetails/?id=746884345)

Expanded Magnorbs is a modification for Starbound, by Azulaloi Champagne.

If you found this build on the Expanded Magnorbs GitHub repo, follow the following instructions to install.
Move the /az-expandedmagnorbs/ directory into your /Starbound/mods/ directory, such that the location of this file reads as follows:
/Starbound/mods/az-expandedmagnorbs/README.md
Expanded Magnorbs is a modification for Starbound, by [Azulaloi Champagne](https://steamcommunity.com/id/azulaloi). The reccomended way to install this mod is through the [steam workshop](https://steamcommunity.com/sharedfiles/filedetails/?id=746884345).

![Ooh, fancy!](_previewimage)

## Alternate Install

The master branch of this repository is used for developemnt, and contents could be unstable, unfinished, or otherwise subject to change. [Stable realeases](https://github.com/qqii/ExpandedMagnorbs/releases) are tagged, and uploaded to the steam workshop.

### Obtaining Files

The files can be obtained in three ways, through the [steam workshop](https://steamcommunity.com/sharedfiles/filedetails/?id=746884345), by downlading a `zip` archive from the github website or by cloning the repository through `git`. It is reccomended to simply subscribe through the [steam workshop](https://steamcommunity.com/sharedfiles/filedetails/?id=746884345) if you are only looking to play the latest version. Obtaining files from this github repository is only suggested if you would like to play an [older version](https://github.com/Azulaloi/ExpandedMagnorbs/releases), try the latest deveopment build or contribute to the project.

### Prerequisites

* [Starbound](https://store.steampowered.com/app/211820/Starbound/) installed
* [`git`](https://git-scm.com/downloads) installed
**OR**
* [zip extractor](https://www.7-zip.org/download.html) installed

#### Download Zip

* Download the repository as a `zip` by clicking `Clone or download` followed by [`Download ZIP`](https://github.com/Azulaloi/ExpandedMagnorbs/archive/master.zip)
OR
* Download the version from the [releases tab](https://github.com/Azulaloi/ExpandedMagnorbs/releases) that you are looking for.
* Extract the archive into your starbound folder `<steam>/Starbound/mods/az-expandedmagnorbs/` such that location of this file reads as follows: `<steam>/Starbound/mods/az-expandedmagnorbs/README.md`

#### Git

* Clone the repository into `<steam>/Starbound/mods/`


If you recieved this build directory from the steam workshop page, it should have automatically been installed properly.

Builds found on the GitHub repo may be a development build. Contents could be unstable, unfinished, or otherwise subject to change.
Builds obtained directly from the steam workshop are always stable releases.