https://github.com/jpenilla/chesscraft

Paper plugin adding in-world chess matches against players and chess engines (CPUs) to Minecraft
https://github.com/jpenilla/chesscraft

chess minecraft-plugin paper-plugin

Last synced: 13 days ago
JSON representation

Paper plugin adding in-world chess matches against players and chess engines (CPUs) to Minecraft

• Host: GitHub
• URL: https://github.com/jpenilla/chesscraft
• Owner: jpenilla
• License: apache-2.0
• Created: 2023-02-05T18:41:00.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2024-10-16T20:44:44.000Z (28 days ago)
• Last Synced: 2024-10-19T14:35:19.727Z (26 days ago)
• Topics: chess, minecraft-plugin, paper-plugin
• Language: Java
• Homepage: https://modrinth.com/plugin/chesscraft
• Size: 1.59 MB
• Stars: 19
• Watchers: 1
• Forks: 2
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        




# ChessCraft

![license](https://img.shields.io/github/license/jpenilla/chesscraft) ![release](https://img.shields.io/github/v/release/jpenilla/chesscraft?color=blue&label=version) [![actions](https://github.com/jpenilla/chesscraft/workflows/build/badge.svg?branch=master)](https://github.com/jpenilla/chesscraft/actions)

ChessCraft is a Paper plugin that adds in-world chess matches against other players and chess engines.

With ChessCraft, players can challenge each other to intense chess battles in a Minecraft environment.



## Features

- In-world chess matches, reminiscent of life-size chess boards.

- Pieces: Supports both custom models through a resource pack (linked below), and using textured player heads for resource pack free use.

- Automatic downloading of the correct Stockfish (chess engine powering ChessCraft) executable for your platform.

- Stores history of paused/incomplete and completed matches

- Export matches in PGN format for external analysis

- Elo rating system for PvP matches with server leaderboard

## Download

Downloads can be obtained from the [releases](https://github.com/jpenilla/chesscraft/releases) section.

Development builds

> Development builds are available at https://jenkins.jpenilla.xyz/job/ChessCraft

## Installation

To install ChessCraft, simply drop the plugin into your Paper server's `plugins` folder.

The configuration can be adjusted at `plugins/ChessCraft/config.yml`.

By default, ChessCraft will be configured for use with a resource pack containing custom models for chess pieces.

It can be downloaded [here](https://github.com/jpenilla/chesscraft/raw/master/resources/ChessCraft_Resource_Pack.zip). You can either have your players manually install it, or set it as your server resource pack/merge its contents into your existing server resource pack.

## Usage

First, you must create a chessboard by standing at the desired location for the southwest corner of the board and using the `/chess create_board  ` command.

Then, use the `/chess challenge player|cpu` commands to challenge an opponent. That's all! Now you can right-click the pieces to start making moves!

Chess boards will not automatically place or remove blocks from the world (besides the pieces if configured to use block pieces), they will only manage pieces. This is to allow

building your chess board in any way you like. However, the `/chess set_checkerboard` command can be used to automatically place blocks for a standard board.

## Contact

[![Discord](https://img.shields.io/discord/714316281918128163?color=8C9CFE&label=Discord&logo=discord&logoColor=white)](https://discord.gg/86Ekw8H)

For questions and support prefer asking in the Discord linked above before opening an issue.

The [issue tracker](https://github.com/jpenilla/chesscraft/issues) is intended for tracking bugs, feature requests, and etc., not support requests.