Skip to content
This repository was archived by the owner on Dec 1, 2022. It is now read-only.

Commit a56dccb

Browse files
jacobtreadjacobtread
committed
Renamed entire project
1 parent 5217372 commit a56dccb

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

79 files changed

+340
-633
lines changed

‎Dockerfile

+24-24
Original file line numberDiff line numberDiff line change
@@ -30,53 +30,53 @@ FROM openjdk:17-alpine
3030

3131
# Use environment variable based config only shouldn't
3232
# be changed unless you want an on disk config as well
33-
ENV KME_ENVIRONMENT_CONFIG=true
33+
ENV RELAY_ENVIRONMENT_CONFIG=true
3434

3535
# External address for clients to access this server through
3636
# this is the address that the redirector will tell the client
3737
# that the main server is hosted at
38-
ENV KME_EXTERNAL_ADDRESS="kme.jacobtread.local"
38+
ENV RELAY_EXTERNAL_ADDRESS="kme.jacobtread.local"
3939

4040
# Server ports
41-
ENV KME_REDIRECTOR_PORT=42127
42-
ENV KME_MAIN_PORT=14219
43-
ENV KME_HTTP_PORT=80
41+
ENV RELAY_REDIRECTOR_PORT=42127
42+
ENV RELAY_MAIN_PORT=14219
43+
ENV RELAY_HTTP_PORT=80
4444

4545
# Database config
46-
ENV KME_DATABASE_TYPE=sqlite
46+
ENV RELAY_DATABASE_TYPE=sqlite
4747

4848
# SQLite config if using SQLite database
49-
ENV KME_SQLITE_FILE_PATH="data/app.db"
49+
ENV RELAY_SQLITE_FILE_PATH="data/app.db"
5050

5151
# MySQL config if using MySQL database
52-
ENV KME_MYSQL_HOST="127.0.0.1"
53-
ENV KME_MYSQL_PORT=3306
54-
ENV KME_MYSQL_USER="root"
55-
ENV KME_MYSQL_PASSWORD="password"
56-
ENV KME_MYSQL_DATABASE="kme"
52+
ENV RELAY_MYSQL_HOST="127.0.0.1"
53+
ENV RELAY_MYSQL_PORT=3306
54+
ENV RELAY_MYSQL_USER="root"
55+
ENV RELAY_MYSQL_PASSWORD="password"
56+
ENV RELAY_MYSQL_DATABASE="kme"
5757

5858
# Message to display in main menu
59-
ENV KME_MENU_MESSAGE="<font color='#B2B2B2'>KME3</font> - <font color='#FFFF66'>Logged as: {n}</font>"
59+
ENV RELAY_MENU_MESSAGE="<font color='#B2B2B2'>KME3</font> - <font color='#FFFF66'>Logged as: {n}</font>"
6060

6161
# Galaxy at war config
62-
ENV KME_GAW_READINESS_DECAY=0.0
63-
ENV KME_GAW_ENABLE_PROMOTIONS=true
62+
ENV RELAY_GAW_READINESS_DECAY=0.0
63+
ENV RELAY_GAW_ENABLE_PROMOTIONS=true
6464

6565
# Logging config
66-
ENV KME_LOGGER_LEVEL=INFO
67-
ENV KME_LOGGER_SAVE=true
68-
ENV KME_LOGGER_PACKETS=false
66+
ENV RELAY_LOGGER_LEVEL=INFO
67+
ENV RELAY_LOGGER_SAVE=true
68+
ENV RELAY_LOGGER_PACKETS=false
6969

7070
# Retriever Config
71-
ENV KME_RETRIEVE_OFFICIAL=true
72-
ENV KME_RETRIEVE_ORIGIN_DATA=true
71+
ENV RELAY_RETRIEVE_OFFICIAL=true
72+
ENV RELAY_RETRIEVE_ORIGIN_DATA=true
7373

74-
ENV KME_MITM_ENABLED=false
74+
ENV RELAY_MITM_ENABLED=false
7575

7676
# Exposing the ports for all the servers
77-
EXPOSE ${KME_REDIRECTOR_PORT}
78-
EXPOSE ${KME_MAIN_PORT}
79-
EXPOSE ${KME_HTTP_PORT}
77+
EXPOSE ${RELAY_REDIRECTOR_PORT}
78+
EXPOSE ${RELAY_MAIN_PORT}
79+
EXPOSE ${RELAY_HTTP_PORT}
8080

8181
# Create an app directory
8282
RUN mkdir "/app"

‎Logo.png

107 KB
Loading

‎README.md

+2-4
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
1-
# KME3
2-
3-
Kotlin Mass Effect 3
1+
![Logo](data/logo.png)
42

53
![License](https://img.shields.io/github/license/jacobtread/KME3?style=for-the-badge)
64
[![Gradle Build](https://img.shields.io/github/workflow/status/jacobtread/KME3/gradle-build?style=for-the-badge)](https://github.com/jacobtread/KME3/actions/workflows/gradle.yml)
75
![Total Lines](https://img.shields.io/tokei/lines/github/jacobtread/KME3?style=for-the-badge)
86

97
[Discord Server (https://discord.gg/yvycWW8RgR)](https://discord.gg/yvycWW8RgR)
108

11-
KME3 is a custom private server for Mass Effect 3 emulating the functionatlity of the official EA servers
9+
Pocket Relay is a custom private server for Mass Effect 3 emulating the functionatlity of the official EA servers
1210
but allowing you to host your own closed off private server or ever a server for playing together over lan
1311

1412
So far this project has become a very well performing server and is constantly being improved and optimized in my free time.

‎build.gradle.kts

+10-10
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
22
import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
33

4-
val kme3Version: String by project
4+
val serverVersion: String by project
55

6-
group = "com.jacobtread.kme"
7-
version = kme3Version
6+
group = "com.jacobtread.relay"
7+
version = serverVersion
88

99
plugins {
1010
kotlin("jvm")
@@ -60,18 +60,18 @@ detekt {
6060
tasks.register("generateConstants") {
6161
val input = file("src/main/resources/templates/Constants.kt.template")
6262
val propertiesFile = rootDir.absoluteFile.resolve("gradle.properties")
63-
val output = file("src/main/kotlin/com/jacobtread/kme/data/Constants.kt")
63+
val output = file("src/main/kotlin/com/jacobtread/relay/data/Constants.kt")
6464

6565
inputs.files(input, propertiesFile)
6666
outputs.file(output)
6767

6868
doFirst {
69-
val kme3Version: String by project
69+
val serverVersion: String by project
7070
val mysqlVersion: String by project
7171
val sqliteVersion: String by project
7272
if (input.exists()) {
7373
val templateFile = input.readText(Charsets.UTF_8)
74-
.replace("%KME_VERSION%", kme3Version)
74+
.replace("%RELAY_VERSION%", serverVersion)
7575
.replace("%MYSQL_VERSION%", mysqlVersion)
7676
.replace("%SQLITE_VERSION%", sqliteVersion)
7777
output.writeText(templateFile, Charsets.UTF_8)
@@ -103,7 +103,7 @@ tasks.withType(Jar::class) {
103103
archiveFileName.set(outputJarFile) // Set the output jar name to server.jar
104104
manifest {
105105
// Set the main class of the jar in the manifest
106-
attributes["Main-Class"] = "com.jacobtread.kme.App"
106+
attributes["Main-Class"] = "com.jacobtread.relay.App"
107107
}
108108
exclude("templates/**")
109109
}
@@ -113,7 +113,7 @@ tasks.withType(Jar::class) {
113113
* Gradle task for starting the application
114114
*/
115115
tasks.create("startApp", JavaExec::class) {
116-
mainClass.set("com.jacobtread.kme.App")
116+
mainClass.set("com.jacobtread.relay.App")
117117
classpath(sourceSets["main"].runtimeClasspath)
118118
workingDir(rootProject.projectDir.resolve("run"))
119119
}
@@ -124,7 +124,7 @@ tasks.create("startApp", JavaExec::class) {
124124
* from the root directory then execute this task
125125
*/
126126
tasks.create("makeCoalesced", JavaExec::class) {
127-
mainClass.set("com.jacobtread.kme.tools.MakeCoalesced")
127+
mainClass.set("com.jacobtread.relay.tools.MakeCoalesced")
128128
classpath(sourceSets["main"].runtimeClasspath)
129129
workingDir(rootProject.projectDir)
130130
}
@@ -135,7 +135,7 @@ tasks.create("makeCoalesced", JavaExec::class) {
135135
* file and all other languages should be named ME3TLK_${LANG_CODE}.tlk
136136
*/
137137
tasks.create("makeTLKs", JavaExec::class) {
138-
mainClass.set("com.jacobtread.kme.tools.MakeTLKs")
138+
mainClass.set("com.jacobtread.relay.tools.MakeTLKs")
139139
classpath(sourceSets["main"].runtimeClasspath)
140140
workingDir(rootProject.projectDir)
141141
}

‎data/logo-small.png

27.7 KB
Loading

‎data/logo.png

115 KB
Loading

‎docs/ENV.md

+27-27
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,21 @@ It is possible to configure KME3 through environment variables. The following pa
66
a list of all of those environment variables
77

88
> NOTE: If you leave out any environment variables, or they are not parsable from user error
9-
> or some other reason then if `KME_ENVIRONMENT_CONFIG` is not true the value in the config
9+
> or some other reason then if `RELAY_ENVIRONMENT_CONFIG` is not true the value in the config
1010
> file will be used otherwise the default value will be used instead
1111
1212
### Base Configuration
1313

1414
| Variable Name | Description |
1515
|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
16-
| KME_ENVIRONMENT_CONFIG | If this is set to true then no config file will be used and only default + environment variables will be used (true/false) |
17-
| KME_EXTERNAL_ADDRESS | This is the address the address that the clients will use to connect to the main server. If you specify a value for this you will nee to ensure the value is accessible to the client |
18-
| KME_MENU_MESSAGE | This is the message displayed on the main menu |
19-
| KME_NETTY_UNPOOLED | This disables netty buffer pooling. This can greatly increase the amount of ununused ram being freed but with a large number of connections this could hurt performance (true/false) disabled by default |
20-
| KME_RETRIEVE_OFFICIAL | Determines whether the server should attempt to get the official information about an origin account when it logs in |
21-
| KME_RETRIEVE_ORIGIN_DATA | If retriever is enabled the user characters, classes, etc. will be retrieved as well |
16+
| RELAY_ENVIRONMENT_CONFIG | If this is set to true then no config file will be used and only default + environment variables will be used (true/false) |
17+
| RELAY_EXTERNAL_ADDRESS | This is the address the address that the clients will use to connect to the main server. If you specify a value for this you will nee to ensure the value is accessible to the client |
18+
| RELAY_MENU_MESSAGE | This is the message displayed on the main menu |
19+
| RELAY_NETTY_UNPOOLED | This disables netty buffer pooling. This can greatly increase the amount of ununused ram being freed but with a large number of connections this could hurt performance (true/false) disabled by default |
20+
| RELAY_RETRIEVE_OFFICIAL | Determines whether the server should attempt to get the official information about an origin account when it logs in |
21+
| RELAY_RETRIEVE_ORIGIN_DATA | If retriever is enabled the user characters, classes, etc. will be retrieved as well |
2222

23-
> NOTE: when using `KME_MENU_MESSAGE` you can use the following codes for special values:
23+
> NOTE: when using `RELAY_MENU_MESSAGE` you can use the following codes for special values:
2424
2525
| Code | Value |
2626
|------|----------------------------------------|
@@ -32,43 +32,43 @@ a list of all of those environment variables
3232

3333
| Variable Name | Description |
3434
|---------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
35-
| KME_REDIRECTOR_PORT | The port to use for the redirector server. You shouldn't change this unless you are behind something forwarding port 42127 otherwise clients won't be able to connect |
36-
| KME_MAIN_PORT | The port for the main server. You can change this value to any port you are able to bind |
37-
| KME_HTTP_PORT | The port for the HTTP server you can change this to any port you are able to bind |
35+
| RELAY_REDIRECTOR_PORT | The port to use for the redirector server. You shouldn't change this unless you are behind something forwarding port 42127 otherwise clients won't be able to connect |
36+
| RELAY_MAIN_PORT | The port for the main server. You can change this value to any port you are able to bind |
37+
| RELAY_HTTP_PORT | The port for the HTTP server you can change this to any port you are able to bind |
3838

3939
### Logging
4040

4141
| Variable Name | Description |
4242
|--------------------|---------------------------------------------------------------------------|
43-
| KME_LOGGER_LEVEL | The level of logging to print to STDOUT (INFO, WARN, ERROR, FATAL, DEBUG) |
44-
| KME_LOGGER_SAVE | Whether to store logs in the logs directory (true/false) |
45-
| KME_LOGGER_PACKETS | Whether to log incoming and outgoing packets (true/false) |
43+
| RELAY_LOGGER_LEVEL | The level of logging to print to STDOUT (INFO, WARN, ERROR, FATAL, DEBUG) |
44+
| RELAY_LOGGER_SAVE | Whether to store logs in the logs directory (true/false) |
45+
| RELAY_LOGGER_PACKETS | Whether to log incoming and outgoing packets (true/false) |
4646

4747
### Database Configuration
4848

49-
`KME_DATABASE_TYPE`: This environment variable is used to specify which type of database
49+
`RELAY_DATABASE_TYPE`: This environment variable is used to specify which type of database
5050
should be used. The value that's specified in this environment variable determines which
5151
database config will be used. The possible values for this are: mysql, and sqlite
5252

5353
#### SQLite Database Configuration
5454

5555
| Variable Name | Description |
5656
|--------------------|-------------------------------------------------------|
57-
| KME_SQLITE_FILE | The file that SQLite should store the database within |
57+
| RELAY_SQLITE_FILE | The file that SQLite should store the database within |
5858

5959
#### MySQL Database Configuration
6060

61-
| Variable Name | Description |
62-
|--------------------|--------------------------------------------------|
63-
| KME_MYSQL_HOST | The host of address / domain of the MySQL server |
64-
| KME_MYSQL_PORT | The port of the MySQL server |
65-
| KME_MYSQL_USER | The user account for the MySQL server |
66-
| KME_MYSQL_PASSWORD | The account password for the MySQL server |
67-
| KME_MYSQL_DATABASE | The database to use in the MySQL server |
61+
| Variable Name | Description |
62+
|----------------------|--------------------------------------------------|
63+
| RELAY_MYSQL_HOST | The host of address / domain of the MySQL server |
64+
| RELAY_MYSQL_PORT | The port of the MySQL server |
65+
| RELAY_MYSQL_USER | The user account for the MySQL server |
66+
| RELAY_MYSQL_PASSWORD | The account password for the MySQL server |
67+
| RELAY_MYSQL_DATABASE | The database to use in the MySQL server |
6868

6969
### Galaxy at war Configuration
7070

71-
| Variable Name | Description |
72-
|---------------------------|----------------------------------------------------------------------------------------------------------------------|
73-
| KME_GAW_READINESS_DECAY | The amount of readiness level to decay each day from last update 0.5 = -1%.Set this value defaults to 0 for no decay |
74-
| KME_GAW_ENABLE_PROMOTIONS | Whether to enable promotions in gaw (use true or false) |
71+
| Variable Name | Description |
72+
|-----------------------------|----------------------------------------------------------------------------------------------------------------------|
73+
| RELAY_GAW_READINESS_DECAY | The amount of readiness level to decay each day from last update 0.5 = -1%.Set this value defaults to 0 for no decay |
74+
| RELAY_GAW_ENABLE_PROMOTIONS | Whether to enable promotions in gaw (use true or false) |

0 commit comments

Comments
 (0)