Windows Installation Guide
Crafty Portable
Running Crafty Portable
- Download the most recent Windows build from https://craftycontrol.com
- Unzip the file downloaded
- Double click on Crafty.exe
Updating Crafty Portable
Make sure to stop Crafty before updating (Ctrl+C)
The Windows Portable build comes with an updater packaged with it, simple as launching the updater and following the prompts 🚀
Crafty Windows Service beta
A .Net6 based Windows Service to run Crafty as a service on Windows
Contents of the package
File | Description |
---|---|
IntallService.ps1 | PowerShell Script used to Install the Service on the computer |
UninstallService.ps1 | PowerShell Script used to Uninstall the service on the computer |
appsettings.json | Configuration file to modifiy some services settings (Installation Folder, Auto-Update, ...) |
CraftyService.exe | The executable of the service (The one that does all the work) |
Install Steps
Requirements:
- Windows 10 or 11
- .NET 6 or Higher
- Internet Connection to download Crafty Files
Preparing with Installation Script:
- Download the latest Windows Service Package: Crafty 4 - Windows Service
- Start the
PowerShell
console with administrator privileges. - Run the
InstallService.ps1
script. - Firstly, it will create a user to run the service and asks for a password for this user. (Remember this for later)
- Then, it will asks if you want to start the service at Startup.
- And that's it for the Installation Script.
- The
PowerShell
console can be closed.
What to do if a login failure appears?
- Open the Services Manager.
- Go to the Crafty Service properties.
- In the connection tab, check if Crafty User is used for opening a session, if not fill in the crafty user credentials.
- You can now start the Crafty Service 🎉
Now Crafty Service is ready to run:
- Go in the Services manager
- Then you can Start the Crafty Service
Requirements:
- Windows 2016 or Higher
- .NET 6 or Higher
- Internet Connection to download Crafty Files
Preparing with Installation Script:
- Download the latest Windows Service Package: Crafty 4 - Windows Service
- Start the
PowerShell
console with administrator privileges - Run the
InstallService.ps1
script - Firstly, it will create a user to run the service and asks for a password for this user. (Remember this for later)
- Then, it will asks if you want to start the service at Startup
- And thats' it for the Installation Script
- The
PowerShell
console can be closed
We need to grant the CraftyUser to run services in the Windows Group Policy:
This step is not needed if the prior step gives you a dialog box of adding the CraftyUser to it.
- Open the Group Policy Strategy Editor
- Go in Computer Config
- Then in Windows Settings
- Then in Security Settings
- Then in Local Strategies
- Then in User rights attribution
- You need to add the Crafty User at the
Open a session as a service
What to do if a login failure appears?
- Open the Services Manager.
- Go to the Crafty Service properties.
- In the connection tab, check if Crafty User is used for opening a session, if not fill in the crafty user credentials.
- Proceed to setup ➡️
Now Crafty Service is ready to run:
- Go in the Services manager
- Then you can Start the Crafty Service
Configuring the Service
In the Folder you have a configuration file named appsettings.json
The part you want to use is this one :
"Crafty": {
"ServiceConfig": {
"DefaultGitPath": "C:\\Program Files\\Git\\bin",
"DefaultPythonPath": "C:\\Program Files\\Python3",
"CraftyDirectory": "crafty-4",
"AutoUpdate": true
},
"UserConfig": {
"CraftyBranch": "master"
}
}
Updating Defaults
- If you installed Git in a different folder that the default one, you can set its path in the
DefaultGitPath
field. - If you installed Python in a different folder or have a different vertsion that the default one, you can set its path in the
DefaultPythonPath
field. - If you want to place Crafty in a different Directory that the Service Files, you can set its path in the
CraftyDirectory
field. !! Not recommended due to Access Rights !! - You can configure if you want Crafty to be updated at the Service Startup in
AutoUpdate
field. - If you want to be with a specific branch of Crafty, you can set it in the
CraftyBranch
field. (Works only with master or dev branch for now.)
Updating the Service
Requirements:
- Rights on the folder containing the Crafty Service Files
- Download of the latests release of the Crafty Service
Update Steps:
- Stop the Crafty Service in the Service Manager
- Copy/Paste, the new files in place of the old ones
- Start again the Crafty Service in the Service Manager
Uninstall Steps
Don't forget to save your Minecraft Worlds before uninstalling!
Uninstallation Steps:
- Start the
PowerShell
console with administrator privileges - Run the
UninstallService.ps1
script - Firstly, it will remove the service from windows.
- Then, it will asks if you want to remove the CraftyUser
- And that's it for the Uninstallation Script
- The
PowerShell
console can be closed - You can now delete your server files.
Post-Install
Great work, You're ready to proceed to the next step 🎉
How to access the dashboard