Skip to content

Commit 18a458b

Browse files
committed
update readme for new build setup
1 parent 6e5fa10 commit 18a458b

File tree

1 file changed

+31
-21
lines changed

1 file changed

+31
-21
lines changed

README.md

+31-21
Original file line numberDiff line numberDiff line change
@@ -6,57 +6,67 @@
66

77
# Requirements
88

9-
- Java 9+
10-
- Java FX
9+
- Java 16+
1110

1211
# ServerSync
1312

14-
A utility for easy mod management. The client will always be able to connect to your server with less instruction required on how to do so.
13+
A utility for easy mod management. The player will always be able to connect to your server with less instruction required on how to do so.
1514

16-
Clients will need to run serversync.jar before starting Minecraft to sync with their desired server (can be [automated](https://github.com/superzanti/ServerSync/wiki/Automation)), sync on connect from within Minecraft is desirable but is currently outside the scope of this project.
15+
Players will need to run serversync.jar before starting Minecraft to sync with their desired server (can be [automated](https://github.com/superzanti/ServerSync/wiki/Automation)).
1716

18-
Technically you could sync any game/filesystem using serversync however it does have some specific funtionality intended for use with Minecraft.
19-
20-
If you don't feel like compiling from the source code and simply want to download a jar file see the [Releases](https://github.com/superzanti/ServerSync/releases).
17+
For pre compiled artifacts see [Releases](https://github.com/superzanti/ServerSync/releases).
2118

2219
## DISCLAIMER:
2320

24-
This utility is only intended for personal use. Other developers work very hard on their mods and simply visiting their website, forum post, or github is just a common courtesy. Please don't use this to mass distribute other people's mods without explicit permisson.
21+
This utility is only intended for personal use. Mod authors work hard on their craft; please support them by visiting their forums, websites or other project sources.
2522

26-
Depending on the copyright and/or pattent laws in your area using this mod with other developer's mods for a commercial purpose could be ILLEGAL, check licenses.
23+
Using this mod for commercial purposes could violate license(s) make sure to check the terms.
2724

28-
This utility allows ANY server running it to put ANY file in your game folder, such as a virus or a keylogger. So if you are a client please make sure you trust your server administrator and as a good measure make sure to scan your games folders for malicious content.
25+
This utility allows servers running it to put **ANY** file in your game folder, such as a virus or a keylogger. So if you are a player please make sure you trust the server you are connecting to, having virus monitoring on the games directory would be a good idea.
2926

3027
## FREQUENTLY ASKED QUESTIONS:
3128

3229
- "This mod isn't doing anything!"
33-
- This version of serversync is run independent of minecraft (minecraft should be closed when running serversync), I did this as minecraft did not need to be running for the program to work and the previous method required you to open and close minecraft several times which if you have any more than 2-3 mods then loading time gets very taxing.
30+
- This version of serversync is run independent of minecraft for performance (minecraft should be closed).
3431
- "I can't connect to my server"
3532
- Check the ip and port details are correct on both server and client.
3633
- Are you using your external/internal IP address?
3734
- Are you trying to transfer a file larger than your max file size?
3835
- Are you ignoring a file that is necessary to connect to the server?
39-
- "This is so insecure I hate it!"
40-
- As per the disclaimer this is not intended to be a super secure system, it's more for personal use.
41-
- Please direct any useful security material to the issues, shall look into it.
4236
- "Can you add feature X? Or fix bug Y?"
43-
- Probably. Submit it to the issues, and I'll check it out.
37+
- Probably. Submit it to the issues.
4438
- "I have files such as Optifine that I don't want the server to delete"
4539
- check out the wiki, there are docs on how to [ignore files](https://github.com/superzanti/ServerSync/wiki/Ignore-&-include-lists-examples)
4640

4741
## What does it do?
4842

49-
ServerSync is a Server <-> Client app, both are bundled into the same file.
43+
ServerSync is a Server <-> Client app, server admins can run the server side while players run the client side.
5044

51-
The server configures what is required for clients to connect and serves files.
45+
Server admins configure the files required in order to connect.
5246

53-
The client requests information from the server and downloads / removes files based on what is required to connect.
47+
Players run the client to check if they need to download updates or new files before starting the game.
5448

5549
## How do I use it?
5650

57-
ServerSync can be used either as a command line tool or a user interface, running with no arguments assumes that you want to start the GUI.
51+
ServerSync can be used either as a command line tool or a user interface.
52+
5853
See: [CLI Wiki](https://github.com/superzanti/ServerSync/wiki/Command-line-arguments) & [Quick Start](https://github.com/superzanti/ServerSync/wiki/Quick-start)
5954

55+
> 💡 the default configuration for your java install may allow 'double click' running for jar files.
56+
57+
### Server Admins
58+
Releases include uber jars and windows executables.
59+
```bash
60+
java -jar serversync-server.jar <args>
61+
```
62+
63+
### Players
64+
Releases include uber jars and windows executables.
65+
```bash
66+
java -jar serversync-client.jar <args>
67+
```
68+
69+
6070
## Working with the code
6171

6272
### Building a Jar
@@ -65,15 +75,15 @@ See: [CLI Wiki](https://github.com/superzanti/ServerSync/wiki/Command-line-argum
6575
./gradlew build
6676
```
6777

68-
Find the output in `./build/libs`
78+
Find the output in `./<project>/build/libs`
6979

7080
### Building exe files
7181

7282
```shell script
7383
./gradlew build createAllExecutables
7484
```
7585

76-
Find the output in `./build/launch4j`
86+
Find the output in `./<project>/build/launch4j`
7787

7888
### Clean project
7989

0 commit comments

Comments
 (0)