You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: COMPILING.md
+5-2Lines changed: 5 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,10 +1,12 @@
1
1
# How to Compile Starcore's Source Code
2
2
3
3
This guide will provide you every step needed to compile and run Starcore.
4
-
__**Please follow and read each step carefully in order for the game to compile and run successfully.**__
4
+
__**Please read and follow each step carefully in order for the game to compile and run successfully.**__
5
5
6
6
## Global Setup (Every Platform)
7
7
8
+
These are the necessary steps required to compile on the game on __***every***__ platform. If you're on either Windows, macOS, or Linux, then read the applicable sub section in section `Extra Steps (for Running and Configuring the Game on Other Platforms)` below.
9
+
8
10
1. Download the [Haxe programming language](https://haxe.org/downloads/). TODO: test version 4.3.4 for compile version!
9
11
- When you download the necessary installer, just use the default options and configurations.
10
12
@@ -33,6 +35,7 @@ __**Please follow and read each step carefully in order for the game to compile
33
35
- This will allow you to compile and run the game on many common platforms, such as every major desktop platform (Windows, macOS, Linux, etc.), both popular mobile systems (Android and iOS), and more.
34
36
35
37
10. Run `lime test html5 --connect 6000` to compile and run the game on the web.
38
+
- You can find the compiled code in the `export/test` folder.
36
39
37
40
> [!TIP]
38
41
> You can replace `html5` with other platforms to compile it accordingly.
@@ -44,7 +47,7 @@ __**Please follow and read each step carefully in order for the game to compile
44
47
1. Navigate to the [setup](setup/) folder and run the `msvs-setup.bat` file to install Visual Studio.
45
48
- This will install everything needed to compile the game to become a Windows application. **This can take a while, so please be patient.**
46
49
47
-
2. When it is done installing, you can then run `lime test windows` to compile the game for Windows.
50
+
2. When it is done installing, you can then run `lime test windows --connect 6000` to compile the game for Windows.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+3-2Lines changed: 3 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -90,15 +90,16 @@ function getLastpressed():FlxKey
90
90
```
91
91
92
92
> [!TIP]
93
-
> You can format a file on VS Code with `SHIFT` + `ALT` + `F` to match the code style standards, although just know that it won't fix typos or correct your grammar, thats all on you!
93
+
> You can format a file on VS Code with `SHIFT` + `ALT` + `F` to match the code style standards, although just know that it won't fix typos or correct your grammar, that's all on you!
94
94
95
95
## Things You CANNOT Do
96
96
97
97
Excluding *collaborators*, there are some files that contributors simply cannot change or delete.
98
98
99
99
1. You are not allowed to change these files:
100
+
- Any files in the [.github folder](.github/)
100
101
- Any files in the [setup folder](setup/).
101
-
- Any files in the [unused folder](unused/), that's for the collaborators!
0 commit comments