Skip to content

Commit cef4811

Browse files
Cuh4Cuh4
committed
initial commit
0 parents  commit cef4811

29 files changed

+8858
-0
lines changed

‎.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
script.lua
2+
.vscode

‎LICENSE

+201
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright [yyyy] [name of copyright owner]
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎README.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
![Game Screenshot](imgs/1.png)
2+
3+
---
4+
5+
# 🌠 | Optimization Addon
6+
7+
## 📚 | Overview
8+
An addon that optimizes Stormworks multiplayer by despawning objects every tick, therefore reducing the amount of things that need to be synchronized between clients in a server.
9+
10+
This addon uses [Aurora Framework](https://github.com/Cuh4/AuroraFramework), a framework I created that tremendously helps with addon development.
11+
12+
Feel free to `git clone`, or even contribute.
13+
14+
## ❓ | Requirements
15+
- **Python 3.12.1+**
16+
- **Stormworks: Build and Rescue** (game)
17+
18+
## 💻 | Setup
19+
### 😎 | Simple
20+
1) [Subscribe to the addon from the Steam workshop.](TODO) TODO
21+
2) Create a new save, but before loading it, enable this addon.
22+
3) When enabling the addon, you will see a cog icon. Click it to open up the options menu, then configure the addon to however you desire. The default options are recommended.
23+
4) Load into the save and go wild.
24+
25+
### 🤓 | Advanced
26+
1) Run `git clone "https://github.com/Cuh4/SWOptimizationAddon.git"`
27+
2) Optionally, change the addon name in `playlist.xml` to whatever you desire.
28+
3) Run `py combiner.py` to merge all of the code into a `script.lua` file. Feel free to stop it with `CTRL + C` once it has been created.
29+
4) Run `sync.bat`. This will effectively clone the addon into `%appdata%/Stormworks/data/missions`, allowing you to use this addon in-game regardless of what directory the addon is in.
30+
5) Create a save with the addon enabled, and have fun with the addon.
31+
32+
## ✨ | Credit
33+
- [**Cuh4**](https://discord.com/users/1141077132915777616) ([GitHub](https://github.com/Cuh4))

‎combiner.py

+125
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
# // ---------------------------------------------------------------------
2+
# // ------- [cuhHub] Tools - Combiner
3+
# // ---------------------------------------------------------------------
4+
5+
# -----------------------------------------
6+
# // ---- Imports
7+
# -----------------------------------------
8+
import os
9+
import time
10+
11+
# -----------------------------------------
12+
# // ---- Variables
13+
# -----------------------------------------
14+
mainPath = "src"
15+
outputPath = "script.lua"
16+
17+
__allowedFileExtensions = [".lua"]
18+
__fileExceptions = []
19+
__folderExceptions = ["src/intellisense"]
20+
21+
# -----------------------------------------
22+
# // ---- Functions
23+
# -----------------------------------------
24+
# // Read a file
25+
def quickRead(path: str):
26+
with open(path, "r") as f:
27+
return f.read()
28+
29+
# // Write to a file
30+
def quickWrite(path: str, content: str):
31+
with open(path, "w") as f:
32+
return f.write(content)
33+
34+
# // Check if path is in list
35+
def pathInList(path: str, paths: list):
36+
for currentPath in paths:
37+
if os.path.samefile(path, currentPath):
38+
return True
39+
40+
return False
41+
42+
# // Get contents of all files in a path
43+
def recursiveRead(targetDir: str, allowedFileExtensions: list[str], fileExceptions: list[str], folderExceptions: list[str]) -> dict[str, str]:
44+
# list files
45+
files = os.listdir(targetDir)
46+
contents = {}
47+
48+
# iterate through them
49+
for file in files:
50+
# get file-related variables
51+
_, extension = os.path.splitext(file)
52+
path = os.path.join(targetDir, file)
53+
54+
# file extension check
55+
if extension == "":
56+
# file is folder, but is an exception
57+
if pathInList(path, folderExceptions):
58+
continue
59+
60+
# file is folder, so read it too
61+
contents = {**contents, **recursiveRead(path, allowedFileExtensions, fileExceptions, folderExceptions)}
62+
63+
# correct extension check
64+
if extension not in allowedFileExtensions:
65+
continue
66+
67+
# exceptions check
68+
if pathInList(path, fileExceptions):
69+
continue
70+
71+
# get file content
72+
content = quickRead(path)
73+
74+
# append file content to contents
75+
contents[path] = content
76+
77+
return contents
78+
79+
# -----------------------------------------
80+
# // ---- Main
81+
# -----------------------------------------
82+
# // Setup
83+
# create output path
84+
folder = os.path.split(outputPath)[0]
85+
86+
if folder != "":
87+
os.makedirs(folder, exist_ok = True)
88+
89+
quickWrite(outputPath, "")
90+
91+
# prevent combining output file and this file
92+
__fileExceptions.extend([outputPath, os.path.relpath(__file__)])
93+
94+
# // Main combine loop
95+
while True:
96+
# wait
97+
time.sleep(0.1)
98+
99+
# get content of all files
100+
result = recursiveRead(
101+
mainPath,
102+
__allowedFileExtensions,
103+
__fileExceptions,
104+
__folderExceptions
105+
)
106+
107+
# print message
108+
print("Combined the following files:\n- " + "\n- ".join([path.replace("\\", "/") for path in result.keys()]))
109+
110+
# format result
111+
for path, content in result.items():
112+
newContent = [
113+
"----------------------------------------------",
114+
f"-- // [File] {path}",
115+
"----------------------------------------------",
116+
content
117+
]
118+
119+
result[path] = "\n".join(newContent)
120+
121+
# dump it into output file
122+
try:
123+
quickWrite(outputPath, "\n\n".join(result.values()))
124+
except:
125+
print("Failed to output.")

‎imgs/1.png

832 KB
Loading

0 commit comments

Comments
 (0)