Condo97/tikfinity_mod

★ 0Forks 0JavaGitHub ↗Compare

README

TikFinity Connector

A 1.20 Fabric mod to connect your TikTok stream to minecraft using TikFinity!

Installation

Fabric

Install Minecraft 1.20.1 and a matching Fabric version (link to the official installation guide)

Fabric API

Install Fabric API.

Cloth Config

Cloth Config is a helper mod used by tikfinity. You need to download and install that alongside the tikfinity mod

Link

Tikfinity Connector

This is the main mod. Download it here or go to the GitHub releases and download the latest tikfinity-x.y.jar (not the sources.jar).

(Optional) Mod Menu

For easier configuration, you can also install Mod Menu.

Link

Usage

Prerequisites

Make sure you have completed the Installation section and have an account on TikFinity.

Then start Minecraft and join any single player world. This mod will not work on a server yet. Use the ServerTap plugin instead.

Setup

Visit TikFinity and go to Setup -> Minecraft Connection and enter the following:

IP: 127.0.0.1

Port: 4567

The password is only used for the ServerTap plugin and does not matter.

Click "Test Connection" and it should show this:

Connection successfully established!

Server Name: TikFinity Mod
Server Version: 1.20.1

Configuration

For now, you can only change the port for the web-server (defaults to 4567).

This is the easiest with the mod menu mod, but can also be manually edited using the config file at config/tikfinity.toml in the instance folder.

Troubleshooting

Connection failed

  • Is the mod installed and shown inside of mod menu?

  • Have you joined a world?

  • Is the port correct? Default: 4567

Not listed here?

Join the Discord

Contributors

jakob-kruseCondo97

Issues