Download the PHP package d3strukt0r/votifier-client without Composer

Votifier Client (for PHP)

This php script allows easy using of the Bukkit plugin Votifier

Project

master-branch (alias stable, latest)

develop-branch (alias nightly)

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.

The full documentation can be found here.

Prerequisites

What things you need to install the software and how to install them

• PHP Project (PHP 7.1+)
• Minecraft server with the Votifier plugin

Installing

Add the client using Composer.

Usage

Simply create an object with all information

For the servers with the classic Votifier plugins:

For the servers which use the NuVotifier plugin (v1 protocol) (HINT: It's NOT the same as method 1):

For the servers which use the NuVotifier plugin with v2 protocol:

Finally, just send it.

Running the tests

Explain how to run the automated tests for this system

Break down into end-to-end tests

Run test scripts

Coding style tests and fixes

To check if the code follows the PSR-12 standard, the library PHP_CodeSniffer has been add to the development environment, but you can also download it separately from here and here.

To see what mistakes exist in the code run:

To fix the code:

This library already comes with php-cs-fixer but because it's impossible to set it up to follow the PSR-12 standard, it's not a requirement anymore. It's been left in the project only for additional styling information that might be applied. It can also be downloaded separately from here.

Code documentation

Install Python v3 from here.

Install Sphinx as documented here.

To build the docs:

Old Code documentation

You can also create a documentation with phpDocumentor. For that please downloaded at least v3+ for to work from here. And then you can just run it

Built With

• PHP - Programming Language
• Composer - Dependency Management
• PHPUnit - Testing the code
• Github Actions - Automatic CI (Testing)
• Read the docs - Documentation

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

• Manuele Vaccari - D3strukt0r - Initial work

See also the list of contributors who participated in this project.

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE.txt file for details

Acknowledgments

• Hat tip to anyone whose code was used
• Inspiration
• etc