Skip to content

Commit 65d7a0c

Browse files
committed
prepare for release
1 parent 82ba347 commit 65d7a0c

File tree

8 files changed

+258
-26
lines changed

8 files changed

+258
-26
lines changed

.env.example

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,4 +64,4 @@ AWS_USE_PATH_STYLE_ENDPOINT=false
6464

6565
VITE_APP_NAME="${APP_NAME}"
6666

67-
CURSEFORGE_API_KEY="$2a$10$bL4bIL5pUWqfcO7KQtnMReakwtfHbNKh6v1uTpKlzhwoueEJQnPnm"
67+
CURSEFORGE_API_KEY=""

.github/workflows/ci.yml

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: [ main ]
6+
pull_request:
7+
branches: [ main ]
8+
9+
jobs:
10+
test:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
- name: Set up PHP
15+
uses: shivammathur/setup-php@v2
16+
with:
17+
php-version: '8.3'
18+
extensions: mbstring, pdo_sqlite, zip
19+
coverage: none
20+
- name: Install Composer dependencies
21+
run: composer install --prefer-dist --no-interaction --no-progress
22+
- name: Copy .env.example
23+
run: cp .env.example .env || true
24+
- name: Set SQLite DB
25+
run: |
26+
touch database/database.sqlite
27+
sed -i 's/^DB_CONNECTION=.*/DB_CONNECTION=sqlite/' .env
28+
sed -i 's/^DB_DATABASE=.*/DB_DATABASE=database\/database.sqlite/' .env
29+
- name: Generate application key
30+
run: php artisan key:generate
31+
- name: Run migrations
32+
run: php artisan migrate --no-interaction --force
33+
- name: Run Pint (code style)
34+
run: vendor/bin/pint --test
35+
- name: Run PHPUnit tests
36+
run: php artisan test --no-interaction

LICENSE

Lines changed: 201 additions & 0 deletions
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

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Override Tracker App
22

33

4-
A Laravel 12 application for preparing and deploying Minecraft modpack releases by comparing a modpack against a remote server snapshot, applying override rules, and syncing changed files over SFTP. The app provides a Web UI (Livewire + Filament where used) and Artisan CLI commands for automation.
4+
A Laravel 12 application for preparing and deploying Minecraft modpack releases by comparing a modpack against a remote server snapshot, applying override rules, and syncing changed files over SFTP. The app provides a simple Web UI for server admins.
55

66
**This README is current as of the workspace snapshot.**
77

@@ -10,6 +10,7 @@ A Laravel 12 application for preparing and deploying Minecraft modpack releases
1010
- Apply override rules per-path using plain text replace, JSON merge, or YAML merge.
1111
- Deploy changed files via SFTP and optionally remove files deleted in the new modpack.
1212
- Keep structured release summaries for review and audit.
13+
- Download modpacks from CurseForge or Feed The Beast
1314

1415
## Stack & Versions
1516
- PHP: 8.3+
@@ -40,41 +41,44 @@ npm install
4041
npm run dev
4142
# To build production assets
4243
# npm run build
44+
45+
# Creating a user
46+
php artisan filament:make-user
4347
```
4448

4549
## Run the app locally
4650

4751
```bash
4852
php artisan serve
49-
# then open http://localhost:8000
5053
```
5154

5255
## Core Concepts
5356
- Server: SFTP connection details and the remote root path plus optional exclude globs.
54-
- Release: A prepared import of a modpack tied to a server and label; stores paths for `new`, `current`, and `prepared` states and a structured summary.
55-
- Override Rule: A rule that matches paths and applies a payload (text, JSON, or YAML) during prepare.
57+
- Release: A prepared import of a modpack tied to a server and label; stores paths for `new`, `remote`, and `prepared` states and a structured summary.
58+
- Override Rule: A rule that matches paths and applies a payload (text, JSON, or YAML) or a file operation (add, remove, skip) during prepare.
5659
- FileChange: Records added/removed/modified files, checksums, and optional text diffs for text files.
5760

5861
## Using the Web UI
5962
- Log in, create a `Server` with SFTP details and optional exclude patterns.
6063
- Add `Override Rules` to modify files during the prepare stage.
61-
- Create a `Release` by uploading a modpack zip (or pointing to an extracted folder if supported). The system snapshots the server, computes diffs, applies overrides, and stores the prepared release.
62-
- Review the release diff and deploy (Maintainer/Admin) — you can choose to delete files removed by the new modpack.
64+
- Create a `Release` by uploading a modpack zip or selecting a new version from the pack provider. The system snapshots the server, computes diffs, applies overrides, and stores the prepared release.
65+
- Review the release diff and deploy (Maintainer/Admin), see a live log of the changes.
66+
- Some issues when updating? There's a backup of the remote downloaded during the preparation available.
6367

6468

6569
## Testing
66-
- Run related tests (only changed/related tests to be quick):
70+
Lots of tests vibe coded by Github Copilot that should cover most flows and actions.
6771

6872
```bash
69-
php artisan test --filter=ReleaseFlowTest
73+
php artisan test
7074
```
7175

7276
# Developer Notes
7377

74-
- Storage layout: modpack files are stored under `storage/app/modpacks/<release_id>/{new,current,prepared}`.
75-
- Follow project Pint formatting: run `vendor/bin/pint` before committing.
78+
- Storage layout: modpack files are stored under `storage/app/modpacks/<release_id>/{new,remote,prepared}`.
79+
- Follow project Pint formatting: run `composer run format` before committing.
7680

77-
Troubleshooting
81+
## Troubleshooting
7882
- UI not reflecting changes: ensure `npm run dev` is running or run `npm run build`.
7983
- SFTP connection issues: confirm host/port/credentials and that the key file (if used) is readable by the process.
8084
- Permission errors: ensure `storage/` and `bootstrap/cache/` are writable by the web user.

composer.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
{
22
"$schema": "https://getcomposer.org/schema.json",
3-
"name": "laravel/laravel",
3+
"name": "stonebound/lithos",
44
"type": "project",
5-
"description": "The skeleton application for the Laravel framework.",
6-
"keywords": ["laravel", "framework"],
7-
"license": "MIT",
5+
"description": "Lithos - Minecraft Modpack Override Tracker and Update Management",
6+
"keywords": ["minecraft", "modpack", "override", "tracker", "server", "management"],
7+
"license": "Apache-2.0",
88
"require": {
99
"php": "^8.2",
1010
"filament/filament": "^4.3",

docs/curseforge.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

docs/feedthebeast.md

Lines changed: 0 additions & 9 deletions
This file was deleted.

fixperms.sh

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
# perms on linux for a sane deployment
12
chown -R user:user .
23
chgrp www-data .
34
chmod 750 .

0 commit comments

Comments
 (0)