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
+3-9Lines changed: 3 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,17 +5,17 @@ __**Please read and follow each step carefully in order for the game to compile
5
5
6
6
## Global Setup (Every Platform)
7
7
8
-
These are the necessary steps required to compile 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.
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
9
10
-
1. Download the [Haxe programming language](https://haxe.org/download/version/4.3.6).
10
+
1. Download the [Haxe programming language](https://haxe.org/downloads/). TODO: test version4.3.4 for compile version!
11
11
- When you download the necessary installer, just use the default options and configurations.
12
12
13
13
2. Download the [Git version control software made by GitHub](https://www.git-scm.com).
14
14
- Similar to when you installed Haxe, just simply use the default configurations when going through the installer.
15
15
16
16
3. Open your operating system's terminal (or Command Prompt, if you're a Windows user).
17
17
18
-
4. Run `cd path/of/your/clone/here`. This is where the game's code will be stored, with `path/of/your/clone/here` being the folder location.
18
+
4. Run `cd path/of/your/clone/here`. This is where the game's code will be stored, with `path/of/your/clone/here` being the file location.
19
19
20
20
> [!TIP]
21
21
> If you're on Windows, it's recommended for your clone's code to be placed in your Documents folder (or, if you have GitHub Desktop installed, in `Documents/GitHub`).
@@ -31,9 +31,6 @@ These are the necessary steps required to compile the game on __***every***__ pl
31
31
32
32
8. Run `hmm install` to start installing all of the game's dependencies. **This will take a bit, so be patient**.
33
33
34
-
> [!TIP]
35
-
> If the libraries do not install correctly, then you can run the `.bat` file or `.sh` file (according to your system).
36
-
37
34
9. Run `haxelib run lime setup` to setup the lime command.
38
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.
39
36
@@ -43,9 +40,6 @@ These are the necessary steps required to compile the game on __***every***__ pl
43
40
> [!TIP]
44
41
> You can replace `html5` with other platforms to compile it accordingly.
45
42
46
-
> [!IMPORTANT]
47
-
> If ever, for some reason, the shaders make the screen become black, it is advised you clear your computer's `Temp/` directory. If the issue persists, then please take a look at the [contributing](CONTRIBUTING.md) file for info on how to report a bug.
48
-
49
43
## Extra Steps (for Running and Configuring the Game on Other Platforms)
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+34-31Lines changed: 34 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ When you write code, heres some simple things we ask of you:
8
8
## Issues
9
9
10
10
If you wish to fix a bug, make an enhancement, or even wish to
11
-
simply make a recommendation, then no worries! You can make an [issue](https://github.com/korithekoder/Starcore/issues)
11
+
simply make a recommendation, then no worries! You can make an [issue](https://github.com/stringfromjava/Starcore/issues)
12
12
or create a sub-issue and help someone with an issue that needs to be worked on!
13
13
14
14
> [!IMPORTANT]
@@ -23,34 +23,35 @@ However, sometimes they can be a hindrance as well.
23
23
24
24
If your comments have typos, aren't clear or concise, or just
25
25
hard to understand in general, then they won't be any
26
-
use. Even too many comments can make it difficult to understand your code.
26
+
use. Even too many comments are unnecessary, since your code should be
27
+
self documented and easily readable.
27
28
28
29
### Example of GOOD Comments (With Good Formatting)
29
30
30
31
```haxe
31
32
/**
32
-
* Get's the last key that was pressed on the current frame.
33
+
* Gets the last key that was pressed on the current frame.
33
34
*
34
35
* @return The last key that was pressed. If no keys were pressed, then
35
-
* `FlxKey.NONE` is returned instead.
36
+
* `FlxKey.NONE` is returned instead.
36
37
*/
37
38
public static function getLastKeyPressed():FlxKey
38
39
{
39
-
for (key in 8...303) // Loop through all keys in FlxKey
40
+
for (key in 8...303) // Loop through all keys in FlxKey
41
+
{
42
+
try
40
43
{
41
-
try
42
-
{
43
-
if (FlxG.keys.anyJustPressed([key]))
44
-
{
45
-
return key;
46
-
}
47
-
}
48
-
catch (e:Exception)
49
-
{
50
-
// Skip and move on if it is not a valid key
51
-
}
44
+
if (FlxG.keys.anyJustPressed([key]))
45
+
{
46
+
return key;
47
+
}
52
48
}
53
-
return FlxKey.NONE;
49
+
catch (e:Exception)
50
+
{
51
+
// Skip and move on if it is not a valid key
52
+
}
53
+
}
54
+
return FlxKey.NONE;
54
55
}
55
56
```
56
57
@@ -66,44 +67,46 @@ public
66
67
static
67
68
function getLastpressed():FlxKey
68
69
{
69
-
// loop thouhg all keys (8-303)
70
+
// loop thouhg all keys (8-303)
70
71
for (key in 8...303) // loop through all keys
71
-
{
72
+
{
72
73
// try to check if its pressed :p
73
-
try{
74
+
try{
74
75
// check if its pressed
75
-
if (FlxG.keys.anyJustPressed([key]))
76
+
if (FlxG.keys.anyJustPressed([key]))
76
77
{
77
-
// return the pressed key
78
-
return key;
78
+
// return the pressed key
79
+
return key;
79
80
}
80
81
}
81
-
// catch the exception
82
-
catch (e:Exception) {
83
-
// just skip with non valid key xd
84
-
}
82
+
// catch the exception
83
+
catch (e:Exception) {
84
+
// just skip with non valid key xd
85
85
}
86
-
// return nnoe if no kyes are pressed
87
-
return FlxKey.NONE;
86
+
}
87
+
// return nnoe if no kyes are pressed
88
+
return FlxKey.NONE;
88
89
}
89
90
```
90
91
91
92
> [!TIP]
92
-
> 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!
93
94
94
95
## Things You CANNOT Do
95
96
96
97
Excluding *collaborators*, there are some files that contributors simply cannot change or delete.
97
98
98
99
1. You are not allowed to change these files:
100
+
- Any files in the [.github folder](.github/)
99
101
- Any files in the [setup folder](setup/).
100
-
- Any files in the [unused folder](unused/), that's for the collaborators!
0 commit comments