Wurst7/README.md

# Wurst Client v7

## Downloads (for users)

[https://www.wurstclient.net/download/](https://www.wurstclient.net/download/?utm_source=GitHub&utm_medium=Wurst7&utm_campaign=README.md&utm_content=Downloads+%28for+users%29)

## Setup (for developers)

(This assumes that you are using Windows with [Eclipse](https://www.eclipse.org/downloads/) and [Java Development Kit 21](https://adoptium.net/?variant=openjdk21&jvmVariant=hotspot) already installed.)

1. Run this command in PowerShell:

```
./gradlew.bat genSources eclipse --no-daemon
```

2. In Eclipse, go to `Import...` > `Existing Projects into Workspace` and select this project.

## Contributing

Pull requests are welcome, but please make sure to read the [contributing guidelines](CONTRIBUTING.md) first.

## Translations

The preferred way to submit translations is through a Pull Request here on GitHub.

To enable translations in-game, go to Wurst Options > Translations > ON.

Names of features (hacks/commands/etc.) should always be kept in English. This ensures that everyone can use the same commands, keybinds, etc. regardless of their language setting. It also makes it easier to communicate with someone who uses Wurst in a different language.

The translation files are located in [this folder](https://github.com/Wurst-Imperium/Wurst7/tree/master/src/main/resources/assets/wurst/translations), in case you need them.

## License

This code is licensed under the GNU General Public License v3. **You can only use this code in open-source clients that you release under the same license! Using it in closed-source/proprietary clients is not allowed!**
Update README.md 2019-09-04 17:59:09 +02:00			`# Wurst Client v7`
Initial commit 2019-06-06 08:11:08 +02:00
Update README.md 2019-09-04 17:59:09 +02:00			`## Downloads (for users)`

Update links 2022-12-15 19:56:52 +01:00			`[https://www.wurstclient.net/download/](https://www.wurstclient.net/download/?utm_source=GitHub&utm_medium=Wurst7&utm_campaign=README.md&utm_content=Downloads+%28for+users%29)`
Update README.md 2019-09-04 17:59:09 +02:00
Update README.md 2022-10-05 12:23:24 +02:00			`## Setup (for developers)`
Initial commit 2019-06-06 08:11:08 +02:00
Update to 24w14a and Java 21 2024-04-03 18:22:15 +02:00			`(This assumes that you are using Windows with [Eclipse](https://www.eclipse.org/downloads/) and [Java Development Kit 21](https://adoptium.net/?variant=openjdk21&jvmVariant=hotspot) already installed.)`
Update Gradle to 7.3 to fix JDK 17 compatibility 2021-11-27 00:46:57 +01:00
Improve contributing guidelines 2024-01-25 21:04:55 +01:00			`1. Run this command in PowerShell:`
Initial commit 2019-06-06 08:11:08 +02:00
			```
Improve contributing guidelines 2024-01-25 21:04:55 +01:00			`./gradlew.bat genSources eclipse --no-daemon`
Initial commit 2019-06-06 08:11:08 +02:00			```

			2. In Eclipse, go to `Import...` > `Existing Projects into Workspace` and select this project.

Update README.md 2022-10-05 12:23:24 +02:00			`## Contributing`

Improve contributing guidelines 2024-01-25 21:04:55 +01:00			`Pull requests are welcome, but please make sure to read the [contributing guidelines](CONTRIBUTING.md) first.`
Update README.md 2022-10-05 12:23:24 +02:00
Update README.md 2022-08-24 00:44:42 +02:00			`## Translations`

Update translations section 2024-07-24 15:28:22 +02:00			`The preferred way to submit translations is through a Pull Request here on GitHub.`
Update README.md 2022-08-24 00:44:42 +02:00
Update README.md 2022-10-05 12:23:24 +02:00			`To enable translations in-game, go to Wurst Options > Translations > ON.`
Update README.md 2022-08-24 00:44:42 +02:00
			`Names of features (hacks/commands/etc.) should always be kept in English. This ensures that everyone can use the same commands, keybinds, etc. regardless of their language setting. It also makes it easier to communicate with someone who uses Wurst in a different language.`

Update translations section 2024-07-24 15:28:22 +02:00			`The translation files are located in [this folder](https://github.com/Wurst-Imperium/Wurst7/tree/master/src/main/resources/assets/wurst/translations), in case you need them.`
Update README.md 2022-08-24 00:44:42 +02:00
Initial commit 2019-06-06 08:11:08 +02:00			`## License`

			`This code is licensed under the GNU General Public License v3. You can only use this code in open-source clients that you release under the same license! Using it in closed-source/proprietary clients is not allowed!`