Skip to content

Commit

Permalink
Linux- Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Tzach Shabtay committed Feb 15, 2018
1 parent 8a88aad commit 63ca466
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 10 deletions.
21 changes: 14 additions & 7 deletions Docs/articles/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,21 +6,28 @@ As there is no release yet, the code needs to be downloaded from the [Github rep

If you're developing from a Windows machine, you need to install [Visual Studio 2017](https://www.visualstudio.com/downloads/) (Community edition is enough and free).

If you're developing from a Mac, you need to install [Xamarin Studio](https://www.xamarin.com/download) (Community edition is enough and free).
If you're developing from a Mac, you need to install [Visual Studio For Mac](https://www.xamarin.com/download) (Community edition is enough and free).

After installing, open your IDE (either Visual Studio or Xamarin Studio) and open the MonoAGS.sln (the solution) file that's in the root folder of the code you downloaded.
If you're developing from Linux, you need to install [Mono](http://www.mono-project.com/download/stable/#download-lin) and [MonoDevelop](http://www.monodevelop.com/download/linux/).

After installing, open Visual Studio and open the MonoAGS.sln (the solution) file that's in the root folder of the code you downloaded.

## Compile the code:

When you want to compile for development purposes, choose the Debug configuration (from the top bar), but when you compile for deploying your game, choose DesktopRelease for desktop or AndroidRelease for android. As for platform, choose "Any Cpu" for desktop and "ARM" for android (note: on Xamarin Studio "Any Cpu" is actually the default option and nothing is written next to the configuration).
When you want to compile for development purposes, choose the Debug configuration (from the top bar), but when you compile for deploying your game, choose DesktopRelease for desktop or AndroidRelease for android. As for platform, choose "Any Cpu" for desktop and "ARM" for android (note: on Mac and Linux "Any Cpu" is actually the default option and nothing is written next to the configuration).

For setting up Android development, see [this](https://developer.xamarin.com/guides/cross-platform/getting_started/installation/windows/#Installation) guide if you're running on Windows and [this](https://developer.xamarin.com/get-started-droid/) guide if you're running on Mac (Android development is currently not possible from Linux). Then setup your device using [this](https://developer.xamarin.com/guides/android/getting_started/installation/set_up_device_for_development/) guide.

For IOS development, you need to run from Mac, see [this](https://developer.xamarin.com/guides/ios/getting_started/installation/) guide for installation, and [this](https://developer.xamarin.com/guides/ios/getting_started/installation/device_provisioning/) guide for setting up your device.
If you own both a Mac and a Windows machine and want to test IOS from your Windows machine, it's possible connecting it to the Mac machine, see [here](https://developer.xamarin.com/guides/ios/getting_started/installation/windows/) for instructions.

## Running the demo:

The game comes with a small demo which you can run to test that everything is working properly (and see a few of the features in action)- if you look at the solution explorer (the side bar) you'll see a demo folder, that contains a DemoQuest.Desktop (for the desktop build) and a DemoQuest.Droid (for the android build). Right click the project which you want to run, and select "Set as startup project". After that, press the "play" button on the top bar (the arrow pointing right) for starting the game. Note that if you run the android version you need to either [attach a device](https://developer.xamarin.com/guides/android/getting_started/installation/set_up_device_for_development/) or run with the [emulator](https://developer.xamarin.com/guides/android/deployment,_testing,_and_metrics/debug-on-emulator/android-sdk-emulator/).
The game comes with a small demo which you can run to test that everything is working properly (and see a few of the features in action)- if you look at the solution explorer (the side bar) you'll see a demo folder, that contains a DemoQuest.Desktop (for the desktop build) and a DemoQuest.Droid (for the android build). Right click the project which you want to run, and select "Set as startup project". After that, press the "play" button on the top bar (the arrow pointing right) for starting the game.

## Solution structure:

The demo folder contains several projects:
The demo folder contains several projects:

*DemoQuest*- this is the project that contains the core logic of the game. It is a shared project that is used by both the desktop and android projects, so you won't have to write your code twice (or more, once more platforms are added).

Expand Down Expand Up @@ -48,8 +55,8 @@ Then copy the boilerplate code from the DemoQuest.Desktop and DemoQuest.Android

The official language for coding your game is C#. There are a lot of resources online for learning c# if needed.
While not officially supported, other languages might be used on some or all platforms (they should play nice with dot net, mono, and xamarin). F# would be the best bet as it's the modern functional language counter-part of c#, but other languages might be partially or fully supported.
See the following links:
See the following links:
- http://www.mono-project.com/docs/about-mono/languages/
- https://en.wikipedia.org/wiki/List_of_CLI_languages

If you have tried using the engine with an alternative language, please let us know your findings.
If you have tried using the engine with an alternative language, please let us know your findings.
26 changes: 23 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# MonoAGS
AGS (Adventure Game Studio) reimagined in Mono

### Builds:

| Windows | Android | Linux | Mac |
Expand All @@ -25,14 +25,34 @@ Code Coverage:

Install Visual Studio 2017 Community, make sure to install both the dot net framework workflow and the mobile workflow.
Right click the solution and build.
Please note that you will not be able to run IOS without a Mac.

To be able to build for Android, follow the tutorial here for setting up: https://developer.xamarin.com/guides/cross-platform/getting_started/installation/windows/#Installation
You'll also need to setup your Android device for testing purposes, see here for instructions: https://developer.xamarin.com/guides/android/getting_started/installation/set_up_device_for_development/.
Once you're setup, select the `AndroidRelease` configuration and the `ARM` architecture (both should be available from the drop downs at the top bar), and then you can build and run.

Please note that you will not be able to run IOS without a Mac, but if you own a Mac, it's possible to connect the Mac to the Windows machine, and run from Windows, see here for setup: https://developer.xamarin.com/guides/ios/getting_started/installation/windows/.

To run the unit tests, please install the NUnit 2 Test Adapter (available from Visual Studio, tools menu -> Extensions and Updates... -> Online).

#### On Mac:

Install the latest edition of Xamarin Studio Community Edition.
Install Visual Studio for Mac Community Edition.
Right click the solution and build.

To be able to build for Android, follow the tutorial here for setting up: https://developer.xamarin.com/get-started-droid/
You'll also need to setup your Android device for testing purposes, see here for instructions: https://developer.xamarin.com/guides/android/getting_started/installation/set_up_device_for_development/.
Once you're setup, select the `AndroidRelease` configuration and the `ARM` architecture (both should be available from the drop downs at the top bar), and then you can build and run.

To be able to build for IOS, follow the tutorial here for setting up: https://developer.xamarin.com/guides/ios/getting_started/installation/
You'll also need to setup your Android device for testing purposes, see here for instructions: https://developer.xamarin.com/guides/ios/getting_started/installation/device_provisioning/.

#### On Linux:

Install Mono and MonoDevelop.
Right click the solution and build.

It's not currently possible compiling for Android & IOS from Linux.

### Documentation

Documentation is available at: https://tzachshabtay.github.io/MonoAGS/

0 comments on commit 63ca466

Please sign in to comment.