Skip to content

Commit

Permalink
Add basic build instructions (#138)
Browse files Browse the repository at this point in the history
  • Loading branch information
sharkwouter committed Dec 28, 2023
1 parent ef67288 commit 89c3905
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 1 deletion.
34 changes: 34 additions & 0 deletions docs/building.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# How to build

To be able to make changes to the Open1560 code a development environment is required. This page will explain how to set this up.

## Visual Studio 2022

The Open1560 code is build and developed using Visual Studio 2022. The community edition can be downloaded [here](https://visualstudio.microsoft.com/vs/community/). Make sure to select `Desktop Development with C++" during the installation.

## Git clone

Use [git](https://git-scm.com/) bash to clone the repo with the following command:
```
git clone https://github.com/0x1F9F1/Open1560.git
```

Replace `0x1F9F1` with your own GitHub username if you created a fork already.

This will create the Open1560 directory.

## Prepare script

After having done that, shift+right click on the directory Open1560 directory and select "Open PowerShell window here". Then run the following command with after replacing the location of the Midtown Madness in it:

```
tools/premake5.exe --MM1_GAME_DIRECTORY=c:/location/of/mm1/installation
```

Make sure to use `/`s and not `\`s in the Midtown Madness path.

This will create the Visual Studio project files which will be used in the next step.

## Get started

Now the code can be openened by double clicking the newly created `build/Open1560.sln` project file for Visual Studio. If all the previous steps were done correctly, clicking `Start Debugging` at the top of the screen in Visual Studio should build and run Open1560. Feel free to play around with the code and make changes.
4 changes: 3 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@ title: Open1560
* Do I need to install dgVoodoo2?
* No, Open1560 uses an OpenGL renderer.
* What does Open1560 change?
* See a list of changes [here](./changes.md)
* See a list of changes [here](./changes.md).
* How do I work with the Open1560 code?
* See the build instructions [here](./building.md).

# Support

Expand Down

0 comments on commit 89c3905

Please sign in to comment.