Skip to content

Installation Guide

firesmasher-c6 edited this page Jun 20, 2026 · 2 revisions

Installation Guide

Learn how to install Coder and get your server ready for scripting.

✅ Prerequisites

Before installing Coder, ensure you have:

  • Server Type: Paper or Spigot (1.20+)
  • Java Version: 11 or higher (Java 21+ recommended)
  • RAM: Minimum 2GB (4GB+ recommended)
  • Disk Space: At least 500MB free
  • Network: Direct access to your server files

Note: Coder is NOT compatible with Bukkit or legacy Spigot versions. Always use Paper for best performance.

📥 Installation Steps

Step 1: Download Coder

  1. Visit the Releases Page
  2. Download the latest Coder-x.x.x.jar file
  3. Save it to your computer (you'll upload it next) Current Version: v1.7.4 (June 19, 2026)

Step 2: Stop Your Server

Stop your Minecraft server gracefully:

# From server console
stop
 
# Or via command if you have access
kill -15 <server_pid>

⚠️ Important: Do NOT force-kill the server. Always use the graceful shutdown command.

Step 3: Upload the JAR

  1. Navigate to your server's /plugins/ directory
  2. Upload the Coder-x.x.x.jar file
  3. Verify the file is in /plugins/ (not in a subdirectory)
your-server/
├── plugins/
│   ├── Coder-1.7.4.jar  ← Place here
│   └── [other plugins...]
├── server.jar
└── [other files...]

Step 4: Start Your Server

Start your server normally:

java -Xmx4G -Xmn1G -jar server.jar nogui

The server will generate Coder's folder structure automatically.

Step 5: Verify Installation

  1. Check the console for the initialization message:
   [Coder] Successfully loaded v1.7.4
   [Coder] Folder structure created
  1. In-game, run: /coder list
    • If successful, you'll see empty list of scripts
    • If error, check console logs

📁 Folder Structure

After first startup, Coder creates this structure:

plugins/
└── Coder/
    ├── config.yml           (Configuration file)
    ├── scripts/             (Your script files go here)
    │   ├── hello.cd         (Example script)
    │   ├── example.java
    │   └── custom.py
    ├── JavaClasses/               (Compiled scripts - auto-managed)
    ├── data/                (Plugin data & variables)
    │   ├── variables.storage
    │   └── variables.obf    (Encrypted variables)
    └── logs/                (Script execution logs)

Folder Purposes

Folder Purpose
scripts/ Place your .cd, .java, .py, .lua script files here
JavaClasses/ Compiled versions of scripts (auto-generated)
data/ Variables and persistent data storage
logs/ Execution logs and debug information
config.yml Plugin configuration and settings

⚙️ Initial Configuration

config.yml Defaults

# Coder Plugin Configuration
plugin:
  version: "1.7.4"
  enabled: true
  debug: false
 
# Server settings
server:
  load-on-startup: false
  max-script-threads: 4
  script-timeout: 300  # seconds
 
# Memory management
memory:
  auto-cleanup: true
  cleanup-interval: 3600
  max-loaded-scripts: 50
 
# Permissions
permissions:
  require-op: false
  require-permission: true
  
# File restrictions
files:
  allow-file-delete: false
  restrict-paths: 
    - "world"
    - "world_nether"

Key Settings

  • load-on-startup - Auto-load scripts when server starts
  • max-script-threads - Concurrent script execution threads
  • script-timeout - Maximum execution time per script (seconds)
  • require-permission - Require explicit permission to run scripts
  • restrict-paths - Prevent scripts from accessing certain folders

🔌 Installing Addons

CodeDSL

  1. Download CodeDSL-2.3.1.jar
  2. Place in /plugins/ folder
  3. Restart server
  4. CodeDSL creates /plugins/Coder/CodeDSL/ folder

CoderJSLoader

  1. Download CoderJSLoader-1.0.0.jar
  2. Place in /plugins/ folder
  3. Restart server
  4. Verify console message: [JS Reflection] SUCCESS!

CoderJavaFixer

  1. Download CoderJavaFixer.jar
  2. Place in /plugins/ folder (after Coder)
  3. Restart server
  4. Configure in /plugins/CoderJavaFixer/config.yml

🐛 Troubleshooting Installation

Plugin Not Loading

Error: [Coder] Failed to initialize

Solutions:

  1. Check Java version: java -version (must be 21+)
  2. Verify JAR is in /plugins/ folder
  3. Check console for specific error messages
  4. Ensure server is Paper or Spigot (not Bukkit)

Folder Structure Not Created

Error: Folder structure not generated

Solutions:

  1. Restart server again (sometimes takes two startups)
  2. Verify /plugins/ folder exists and is writable
  3. Check file permissions: chmod 755 /plugins/
  4. Restart server with full output: java -jar server.jar

Commands Not Working

Error: /coder list returns error

Solutions:

  1. Verify plugin loaded: check console for [Coder] messages
  2. Check player permissions: coder.list
  3. Ensure you're running as OP or have permission node
  4. Try /coder update to verify plugin is responsive

Performance Issues

Symptom: Server lag after installation

Solutions:

  1. Check /coder list - too many scripts loaded?
  2. Reduce max-script-threads in config.yml
  3. Increase server RAM in startup command
  4. Review script execution with /coder debug

✅ Verification Checklist

After installation, verify:

  • Server starts without Coder errors
  • /coder list command works
  • /plugins shows Coder in plugin list
  • /coder update shows version check
  • Folder structure exists at /plugins/Coder/
  • Can place script in /plugins/Coder/scripts/
  • Can execute script with /coder run script_name

🚀 Next Steps

Once installation is complete:

  1. Quick Start: Read Quick Start guide
  2. Learn Syntax: Review Syntax Reference
  3. Try Examples: Copy examples from Examples & Tutorials
  4. Create Script: Write your first custom script
  5. Optimize: Learn Performance Optimization

🆘 Getting Help

If you encounter issues:

  1. Check Troubleshooting page
  2. Review console logs in /plugins/Coder/logs/
  3. Search GitHub Issues
  4. Ask in Discord Community
  5. Create a GitHub Issue with logs attached

Installation Complete! 🎉

Ready to create your first script? Continue to Quick Start.

📚 Coder Wiki


🚀 GETTING STARTED

Essential Pages


📖 CORE DOCUMENTATION

Language & Syntax

Addons


🎯 BY SKILL LEVEL

👶 Beginner

  1. Quick Start
  2. Syntax Reference (basic section)
  3. Copy examples from FAQ 🎯 Intermediate
  4. Master Syntax Reference
  5. Learn all Commands
  6. Explore CodeDSL addon 🏆 Advanced
  7. Deep dive CoderJSLoader
  8. Custom command development
  9. Performance optimization tips

🔗 EXTERNAL LINKS

Official Resources

Resource Link
GitHub Repository
Downloads Releases
Modrinth Download
SpigotMC Download

Community

Channel Link
Discord Join Server
Issues Bug Reports
Discussions Q&A

📊 VERSION INFO

Current: v1.7.4
Released: June 19, 2026
Status: ✅ Active Development

Supported Servers:

  • Paper 1.21 - 26.2
  • Java 21+

💡 QUICK TIPS

📌 New to Coder? Start with Quick Start

📌 Looking for a command? Check Commands

📌 Need examples? Browse Syntax Reference

📌 Can't find answer? Try FAQ


🆘 SUPPORT

Having issues?

  1. Check FAQ
  2. Review Installation Guide
  3. Create GitHub Issue
  4. Ask on Discord

🤝 CONTRIBUTE

Help improve Coder!


Clone this wiki locally