valzargaming/byond

A PHP class for interacting with BYOND (Build Your Own Net Dream) servers, providing functionalities to retrieve player information and manage game-related data. Designed to be used in conjunction with a caching system for optimal performance.

v2.0.1 2024-08-13 05:14 UTC

Requires

• php: >=7.4

MIT

• Valithor Obsidion

• byond

README

Overview

The Byond PHP class is designed to interact with the website for BYOND (Build Your Own Net Dream), facilitating the retrieval of player information and management of account-related data. This class is particularly useful for developers working on BYOND projects, providing an easy-to-use interface for accessing and manipulating data related to players and their accounts.

Features

• Convert BYOND timestamps to Unix timestamps and ISO 8601 format.
• Retrieve player details such as gender, join date, description, and homepage from BYOND pages.
• Designed to be used in combination with a caching system to enhance performance.

Implementation

The Byond class implements the ByondInterface and uses the ByondTrait to provide its functionality.

Installation

Install the package via Composer:

composer require valzargaming/byond

Usage

Here is a basic example of how to use the Byond class:

<?php
require 'vendor/autoload.php';

use Byond\Byond;

// Convert BYOND timestamp to Unix timestamp
$byondTimestamp = 1234567890;
$unixTimestamp = Byond::convertToUnixFromByond($byondTimestamp);
echo "Unix Timestamp: " . $unixTimestamp . PHP_EOL;

// Convert BYOND timestamp to ISO 8601 format
$isoTimestamp = Byond::convertToTimestampFromByond($byondTimestamp);
echo "ISO 8601 Timestamp: " . $isoTimestamp . PHP_EOL;

// Parse player information from a BYOND page
$pageContent = Byond::getProfilePage('valithor');
$key = Byond::parseKey($pageContent);
$gender = Byond::parseGender($pageContent);
$joined = Byond::parseJoined($pageContent);
$description = Byond::parseDesc($pageContent);
$homePage = Byond::parseHomePage($pageContent);

echo "Key: " . $key . PHP_EOL;
echo "Gender: " . $gender . PHP_EOL;
echo "Joined: " . $joined . PHP_EOL;
echo "Description: " . $description . PHP_EOL;
echo "Home Page: " . $homePage . PHP_EOL;

Contributing

Contributions are welcome! Please submit a pull request or open an issue to discuss any changes you would like to make.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Author

Valithor Obsidion - [e-mail]