Skip to content

Latest commit

 

History

History
465 lines (360 loc) · 19.2 KB

README.md

File metadata and controls

465 lines (360 loc) · 19.2 KB
Raw

T6 Server - Plutonium Black Ops II Server Installer

Version Debian Plutonium T6 License GitHub repo size GitHub stars GitHub forks GitHub issues GitHub last commit

image Plutonium showLogo

T6 Server is a comprehensive management suite for setting up and running Plutonium Call of Duty: Black Ops II servers on Debian-based systems. This project aims to simplify the process of installing, configuring, and managing T6 servers, making it accessible to both beginners and experienced server administrators.

Full video tutorial: https://www.youtube.com/watch?v=iuTV-8hCv7M

Table of Contents

Features

  • Easy installation and uninstallation process
  • Automated system updates and dependency management
  • Firewall configuration and management with UFW
  • Wine installation for Windows application support
  • .NET Framework installation for IW4MAdmin support
  • Multi-language support (English and French)
  • Server binary installation and configuration
  • User-friendly command-line interface
  • MOD support with custom maps and game modes
  • Advanced server configuration options
  • Automatic server monitoring and resource tracking
  • CPU and memory usage limits
  • Detailed installation/uninstallation summaries
  • System health monitoring and reporting
  • Comprehensive logging and error handling
  • Performance optimization tools

Prerequisites

System Requirements

  • Operating System: Debian 10, 11, or 12 (64-bit)
  • Architecture: x86_64 (AMD64)
  • RAM: Minimum 512MB, 2GB recommended
  • Storage: At least 15GB of free disk space

Software Requirements

  • Root Access: Full system privileges (root or sudo)
  • Package Manager: apt (comes pre-installed on Debian)
  • Git: For cloning the repository

If you don't have sudo or git installed, you can install them as follows:

  1. To install sudo (as root):

    apt install sudo

  2. To install git:

    sudo apt install git

These commands will ensure you have the necessary software to proceed with the installation.

Network Requirements

  • Internet Connection: Stable broadband connection
  • Firewall: Ability to open and forward necessary ports
  • Static IP: Recommended for consistent server accessibility

Additional Considerations

  • Basic familiarity with Linux command line
  • Understanding of server administration concepts
  • Willingness to troubleshoot potential issues

Ensure all prerequisites are met before proceeding with the installation to guarantee a smooth setup process.

Installation

  1. Navigate to the application installation directory:

    cd /opt

  2. Download and extract T6Server archive in a single command:

    mkdir -p T6Server && wget -O T6Server.tar.gz https://github.com/Sterbweise/T6Server/releases/download/v3.1.1/T6Server.tar.gz && tar -xzvf T6Server.tar.gz -C T6Server && rm T6Server.tar.gz

  3. Move into the newly created T6Server directory:

    cd T6Server

  4. Make the script executable:

    chmod +x install.sh

  5. Launch the installation script with sudo privileges:

    sudo ./install.sh

  6. Follow the on-screen instructions to complete the installation. The script will guide you through:

    • Language selection
    • UFW firewall installation and configuration
    • SSH port configuration
    • .NET installation (optional, required for IW4MAdmin)
    • Wine installation
    • Game binary installation

Configuration

After installation, the primary configuration file to modify is /opt/T6Server/T6Server.sh. This file contains essential settings for your Plutonium Call of Duty: Black Ops II server. Below are the key variables you should configure:

Variable Description Default Value
SERVER_NAME The name of your server as it appears in server lists "SERVER_NAME"
GAME_PATH Path to your game files (Multiplayer or Zombie mode) "/opt/T6Server/Server/Multiplayer"
SERVER_KEY Your unique Plutonium server key "YOURKEY"
CONFIG_FILE Server configuration file (mode-specific) "dedicated.cfg"
SERVER_PORT UDP port your server will listen on 21889
GAME_MODE Game mode selection ("t6mp" or "t6zm") "t6mp"
MOD Path to your MOD directory (optional) ""
ADDITIONAL_PARAMS Additional parameters for the server (optional) ""

To configure your server:

  1. Open the configuration file:

    nano /opt/T6Server/Plutonium/T6Server.sh

  2. Modify the variables according to your preferences. For example:

    readonly SERVER_NAME="My Awesome T6 Server" # The name of your server
readonly SERVER_KEY="your_server_key" # Key provided by Plutonium
readonly SERVER_PORT=4976 # Default port for T6 servers
readonly GAME_MODE="t6mp" # "t6mp" for Multiplayer, "t6zm" for Zombies
readonly MOD="mods/weapons" # MOD path
readonly ADDITIONAL_PARAMS="" # Additional parameters for the server

  3. Save the file and exit the editor by pressing Ctrl+x, then Y to confirm, and Enter to save.

Note: For Zombie mode, set GAME_PATH to "/opt/T6Server/Server/Zombie", CONFIG_FILE to "dedicated_zm.cfg", and GAME_MODE to "t6zm". Also, set the MOD variable to the path of the Zombie mode MOD.

Ensure all settings are correctly configured before launching your server.

New Server Parameters

  • sv_allowAimAssist: Enable/disable aim assist (default: 1)
  • sv_securityLevel: Server security level (recommended: 23)
  • sv_kickBareGUID: Kicks players without valid GUID
  • sv_allowDof: Controls depth of field effect

Default Ports

  • T6 (Black Ops II): 21889 (UDP)

Directory Structure

Directory Path Description
Mods /opt/T6Server/Plutonium/storage/t6/mods/ Custom game modifications
Config - Multiplayer /opt/T6Server/Server/Multiplayer/main/configs/ Multiplayer configuration files
Config - Zombie /opt/T6Server/Server/Zombie/main/configs/ Zombie mode configuration files
Logs /opt/T6Server/Plutonium/storage/t6/logs/ Server log files
Stats /opt/T6Server/Plutonium/storage/t6/stats/ Player statistics
Playlists /opt/T6Server/Plutonium/storage/t6/playlists/ Custom game playlists
Game Settings /opt/T6Server/Plutonium/storage/t6/gamesettings/ Game mode settings
Player Data /opt/T6Server/Plutonium/storage/t6/players/ Player-specific data
Scripts /opt/T6Server/Plutonium/storage/t6/scripts/ Custom game scripts
Maps - Multiplayer /opt/T6Server/Server/Multiplayer/usermaps/ Custom multiplayer maps
Maps - Zombie /opt/T6Server/Server/Zombie/usermaps/ Custom zombie maps

To change maps:

  1. Edit the appropriate configuration file:
    • Multiplayer: /opt/T6Server/Server/Multiplayer/main/dedicated.cfg
    • Zombie: /opt/T6Server/Server/Zombie/main/dedicated_zm.cfg

File Organization

For proper server organization, place files in these specific directories:

Custom Mods

  1. Place mod files in /opt/T6Server/Plutonium/storage/t6/mods/
  2. Enable mods by adding to server config: 
    set sv_enablemods "1"
set fs_game "mods/mod_name"

Custom Maps

  1. Place custom map files in their respective directories:

    • Multiplayer maps: /opt/T6Server/Server/Multiplayer/usermaps/
    • Zombie maps: /opt/T6Server/Server/Zombie/usermaps/

  2. Load custom maps by adding them to the map rotation in the config files:

    // For Multiplayer (in dedicated.cfg)
sv_maprotation "map usermaps/custom_map_name map mp_nuketown_2020"
sv_maprotationcurrent ""

// For Zombies (in dedicated_zm.cfg) 
sv_maprotation "map usermaps/custom_zombie_map"
sv_maprotationcurrent ""

  3. Map file organization:

    • Map files (.ff extension) go directly in the usermaps folder
    • Supporting files like textures and models should be in a subfolder with the same name as the map
    • Example structure: 
      usermaps/
├── custom_map.ff
└── custom_map/
    ├── textures/
    ├── models/
    └── other assets/

  4. Important notes:

    • Maps must be in the correct format (.ff files)
    • File permissions should be set to allow server read access
    • Map names in rotation must exactly match the filename (without .ff)
    • Restart server after adding new maps

Launching the Server

To launch your Plutonium Call of Duty: Black Ops II server, follow these professional steps:

  1. Navigate to the T6Server installation directory:

    cd /opt/T6Server/Plutonium

  2. Ensure the start script has the necessary execution permissions:

    sudo chmod +x T6Server.sh

  3. Launch the server:

    ./T6Server.sh

For advanced server management:

  • To run multiple servers concurrently, utilize terminal multiplexers such as tmux or screen.
  • For background operation, you can use the nohup command: 
    nohup ./T6Server.sh > server.log 2>&1 &
    This will run the server in the background, redirecting output to server.log.

Note: Ensure all necessary configurations in server.cfg and other relevant files are properly set before launching the server.

Troubleshooting

This section provides solutions to common issues you may encounter while setting up and running your Plutonium Call of Duty: Black Ops II server. Follow these detailed steps to resolve problems efficiently.

Wine Display Errors

Issue: You may see error messages related to Wine display when starting the server.

Solution: These errors are not critical and can be safely ignored. The Plutonium server operates as a console application and does not require graphical support. Your server will function correctly despite these messages.

Note for debugging: By default, Wine errors are hidden. If you need to debug Wine-related issues, you can remove the 2>/dev/null at the end of the server start command in T6Server.sh. This will allow Wine errors to be displayed, which can be helpful for troubleshooting.

Unable to Load Import from binkw32.dll

Issue: An error occurs when the server attempts to load binkw32.dll.

Solution:

  1. Verify the PAT variable in T6Server.sh:
    • Open the file: nano /opt/T6Server/T6Server.sh
    • Ensure the PAT variable is correctly set to your server's path, pointing to the directory containing binkw32.dll:
      • For Multiplayer: /opt/T6Server/Server/Multiplayer
      • For Zombie mode: /opt/T6Server/Server/Zombie
  2. Correct file permissions: 
    sudo chmod -R 755 /opt/T6Server
  3. If the issue persists, try reinstalling the game binaries using the installation script.

Server Not Appearing in Plutonium Server List

Issue: Your server is running but not visible to players in the Plutonium server list.

Solution:

  1. Verify port accessibility:
    • Ensure the server port (default: 4976) is open for UDP traffic
    • Use a port checking tool to confirm the port is reachable from the internet
  2. Configure your firewall: 
    sudo ufw allow 4976/udp comment "Plutonium-Server"
sudo ufw reload
  3. If behind a NAT:
    • Configure port forwarding on your router
    • Forward UDP port 4976 to your server's local IP address
  4. Verify server configuration:
    • Check server.cfg for correct settings
    • Ensure sv_lanOnly is set to 0

Authentication Issues

Issue: You encounter authentication errors when starting the server.

Solution:

  1. Verify your Plutonium key:
  2. Check key placement:
    • Open T6Server.sh
    • Ensure the SERVER_KEY variable contains your correct key
  3. If issues persist:
    • Reinstall game binaries using the installation script
    • Update Plutonium to the latest version

For additional assistance, consult the Plutonium forums or join the Plutonium Discord community.

Documentation

For more detailed information on server configuration, configuration options, and advanced features, please refer to our Wiki.

Contributing

I appreciate contributions from the community! Here are some ways you can contribute to the T6 Server project:

Submitting Pull Requests

  1. Fork the repository and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. Ensure your code follows the existing style to maintain consistency.
  4. Update the documentation if you've made changes that affect it.
  5. Write a clear and descriptive commit message.
  6. Open a pull request with a comprehensive description of the changes.

Ideas for Contributions

  • Implement additional server configuration options
  • Improve error handling and logging
  • Enhance the user interface of the management scripts
  • Optimize server performance
  • Improve compatibility with different Debian versions or other Linux distributions
  • Create additional language localizations

Reporting Issues

  • Use the GitHub issue tracker to report bugs
  • Provide a clear and detailed description of the issue
  • Include steps to reproduce the problem
  • Specify your operating system and relevant software versions

Improving Documentation

  • Help improve the README, wiki, or inline code documentation
  • Write tutorials or guides for setting up and managing servers
  • Create or improve troubleshooting guides

Code Review

  • Review pull requests from other contributors
  • Provide constructive feedback and suggestions

I strive to make contributing to T6 Server a positive experience for everyone.

Thank you for helping make T6 Server better!

Roadmap

T6 Server focuses on enhancing stability, improving user experience, and expanding functionality. Here's what we're planning:

Short-term Goals (1-3 months)

  • Resolve installation issues on various Debian-based distributions
    • Fix dependency conflicts
    • Improve error handling during installation
    • Create detailed troubleshooting guides
  • Enhance debugging capabilities
    • Implement verbose logging options
    • Create a diagnostic tool for common issues
  • Optimize server performance
    • Reduce resource usage
    • Improve startup and shutdown times

Medium-term Goals (3-6 months)

  • Simplify multi-server management
  • Enhance configuration options
    • Add more customizable server settings
    • Create configuration templates for popular game modes
  • Improve update mechanism
    • Implement automatic updates with rollback capability
    • Add delta updates to reduce bandwidth usage

I'm committed to continuously improving T6 Server based on user feedback and community needs. If you encounter any issues or have suggestions, please don't hesitate to open an issue or contribute to the project!

License

This project is licensed under the GPL-3.0 License - see the LICENSE file for details.

Acknowledgements

I would like to express my sincere gratitude to the following projects and their creators for their invaluable contributions to the T6 Server project:

  • Plutonium: For their exceptional work on the T6 client and server, which forms the foundation of our project. Their dedication to preserving and enhancing classic Call of Duty titles is commendable.

  • IW4MAdmin: I extend my thanks to RaidMax and the IW4MAdmin team for their comprehensive administration tools. Their robust solution significantly enhances server management capabilities.

  • plutonium-updater: Special recognition goes to mxve for developing the plutonium-updater. This tool has been instrumental in streamlining our server update process, ensuring that our servers always run the latest version with minimal downtime.

These projects have been crucial in the development and ongoing improvement of T6 Server. I am deeply appreciative of the hard work and dedication of all contributors involved in these projects.

Support

For support, please contact:

You can also open an issue on this repository for bug reports or feature requests.

Developed with ❤️ by Sterbweise