tmText

Trackmania and Maniaplanet text parser and formatter

☄️ Bug reports / feature requests »

Table Of Contents

• 👋 About The Project
• 🚀 Installation
• 👀 Usage
• 👍 Supported Tokens
• 💻 Development
• ❤️ Contributing
• ⭐ License
• 🌐 Acknowledgments

👋 About The Project

This project aims to provide a simple interface for parsing and formatting text of Trackmania and Maniaplanet games.

Text formatting and colour codes in TrackMania and ManiaPlanet can be used for players' nicknames, track names and comments, music file comments, server names and comments, and in-game online chats.
-- https://wiki.xaseco.org/wiki/Text_formatting

Given an input text of:
$f00R$fa2a$ff3i$0f0n$06fb$30fo$60fw
this library produces the following HTML output:
Rainbow

🚀 Installation

Yarn

yarn add tm-text

NPM

npm i tm-text

👀 Usage

tmText can be used as an ES module as well as a CommonJS module:

ESM

import tmText from 'tm-text';
// or
import { tmText } from 'tm-text';

CommonJS

const { tmText } = require('tm-text');
// or
const tmText = require('tm-text').default;
// or
const { default: tmText } = require('tm-text');

From now on only the ES module syntax will be shown.

Member functions

import tmText from 'tm-text';

const text = tmText('$s$00dFl$24fas$26fh$24fba$00dck');

// Input string without special tokens ('Flashback')
console.log(text.humanize());

// HTML string with applied styles
console.log(text.htmlify());

// Array of tokens of the input string
console.log(text.tokenize());

// Array of blocks of the input string
console.log(text.blockify());

Exported functions

import {
  blockify,
  htmlify,
  humanize,
  tokenize,
} from 'tm-text';

const text = '$s$00dFl$24fas$26fh$24fba$00dck';

// Input string without special tokens ('Flashback')
console.log(humanize(text));

// HTML string with applied styles
console.log(htmlify(text));

// Array of tokens of the input string
console.log(tokenize(text));

// Array of blocks of the input string
console.log(blockify(text));

👍 Supported Tokens

|Token|Description| |-|-| |$000 - $fff|Any color code that matches this pattern: \$[a-f0-9]{3}/i| |$o|Bold text| |$i|Italic text| |$t|Uppercase text| |$s|Text shadow| |$m|Normal text width| |$n|Narrow text width| |$w|Wide text width| |$g|Reset color to default| |$z|Reset text to default| |$h|Internal Link| |$p|Internal Link with player parameters| |$l|External Link| |$<|Opening block| |$>|Closing block| |$$|Dollar character|

Please note that some of the behavior regarding block tags in conjuction with link tags will not be accurately represented by this library.
See these tests for a few examples of what this is referring to.

💻 Development

Make sure to run yarn before attempting to run any of the commands listed below:

Run tsc in watch mode

yarn dev

Run type checking

yarn type-check

Run linter

yarn lint

Run tests

yarn test

Build project

yarn build

❤️ Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch => git checkout -b feature/my-new-feature
3. Commit your Changes => git commit -m 'feat(my-new-feature): add some awesome new feature'
4. Push to the Branch => git push origin feature/my-new-feature
5. Open a Pull Request

⭐ License

Distributed under the MIT License. See LICENSE for more information.

🌐 Acknowledgments

• Maniaplanet Docs
• Mania Tech Wiki
• TypeScript
• Jest
• Best-README-Template by othneildrew
• Choose an Open Source License
• Img Shields