Apparently forgot how docstrings worked
This commit is contained in:
1 parent
f8c17bb20d
commit
ba31b7241c
1 file changed
+20
-15
@@ -3,10 +3,12 @@ from sys import argv
|
|||||||
# Currently the only possible value
|
# Currently the only possible value
|
||||||
SERVER_SUFFIX = "-Master-1"
|
SERVER_SUFFIX = "-Master-1"
|
||||||
|
|
||||||
"""
|
|
||||||
Generates the bytearray with the specified values
|
|
||||||
"""
|
|
||||||
def gen_file(region_name: str, ip_address: str = "127.0.0.1", port: int = 22023) -> bytearray:
|
def gen_file(region_name: str, ip_address: str = "127.0.0.1", port: int = 22023) -> bytearray:
|
||||||
|
"""
|
||||||
|
Generates the bytearray with the specified values
|
||||||
|
"""
|
||||||
|
|
||||||
# Make sure all variables are within the correct length range
|
# Make sure all variables are within the correct length range
|
||||||
if (len(region_name + SERVER_SUFFIX) > 0xff):
|
if (len(region_name + SERVER_SUFFIX) > 0xff):
|
||||||
raise ValueError("Region name too long")
|
raise ValueError("Region name too long")
|
||||||
@@ -39,24 +41,27 @@ def gen_file(region_name: str, ip_address: str = "127.0.0.1", port: int = 22023)
|
|||||||
|
|
||||||
return data
|
return data
|
||||||
|
|
||||||
"""
|
|
||||||
Creates and writes the among us regionInfo.dat file
|
|
||||||
Example:
|
|
||||||
```py
|
|
||||||
try:
|
|
||||||
writeFile("Example server", "169.0.0.1", port=12345))
|
|
||||||
print("Success!")
|
|
||||||
except Exception as error:
|
|
||||||
print(error)
|
|
||||||
```
|
|
||||||
Port should currently always be 22023 for it to work
|
|
||||||
"""
|
|
||||||
def write_file(region_name: str, ip_address: str = "127.0.0.1", file_name: str = "regionInfo.dat", port: int = 22023):
|
def write_file(region_name: str, ip_address: str = "127.0.0.1", file_name: str = "regionInfo.dat", port: int = 22023):
|
||||||
|
"""
|
||||||
|
Creates and writes the among us regionInfo.dat file
|
||||||
|
Example:
|
||||||
|
```py
|
||||||
|
try:
|
||||||
|
writeFile("Example server", "169.0.0.1", port=12345))
|
||||||
|
print("Success!")
|
||||||
|
except Exception as error:
|
||||||
|
print(error)
|
||||||
|
```
|
||||||
|
Port should currently always be 22023 for it to work
|
||||||
|
"""
|
||||||
|
|
||||||
# Generate the file and save to the specified file_name
|
# Generate the file and save to the specified file_name
|
||||||
data = gen_file(region_name, ip_address, port)
|
data = gen_file(region_name, ip_address, port)
|
||||||
with open(file_name, "wb") as file:
|
with open(file_name, "wb") as file:
|
||||||
file.write(data)
|
file.write(data)
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
print(f"Creating file using {argv[1:]}")
|
print(f"Creating file using {argv[1:]}")
|
||||||
write_file(*argv[1:])
|
write_file(*argv[1:])
|
||||||
Reference in new issue
Block a user