From a099ebb68987e9a03c96d51102f6c9a92bf0592c Mon Sep 17 00:00:00 2001 From: Gabber235 Date: Fri, 9 Aug 2024 16:45:14 +0200 Subject: [PATCH] Auto sync readme with modrinth --- .github/workflows/sync-readme.yml | 19 +++++++++++++++++++ README.md | 21 ++++++++++----------- build-all.sh | 31 ------------------------------- 3 files changed, 29 insertions(+), 42 deletions(-) create mode 100644 .github/workflows/sync-readme.yml delete mode 100755 build-all.sh diff --git a/.github/workflows/sync-readme.yml b/.github/workflows/sync-readme.yml new file mode 100644 index 0000000000..0d2d373a52 --- /dev/null +++ b/.github/workflows/sync-readme.yml @@ -0,0 +1,19 @@ +name: Sync README + +on: + push: + branches: + - develop + paths: + - .github/workflows/sync-readme.yml + - README.md + +jobs: + modrinth-desc: + runs-on: 'ubuntu-latest' + steps: + - uses: actions/checkout@v3 + - uses: funnyboy-roks/modrinth-auto-desc@v1.5 + with: + auth-token: ${{ secrets.MODRINTH_TOKEN }} + slug: 'typewriter' diff --git a/README.md b/README.md index b364a02146..4299d57837 100644 --- a/README.md +++ b/README.md @@ -3,13 +3,12 @@ ###### The next generation of questing in minecraft. [![Discord](https://img.shields.io/discord/1054708062520360960?label=discord&logo=discord&logoColor=white)](https://discord.gg/HtbKyuDDBw) -[![Release](https://img.shields.io/github/v/release/gabber235/Typewriter?include_prereleases&logo=github)](https://github.com/gabber235/TypeWriter/releases) Typewriter is a plugin for **Paper** Minecraft servers that allows for custom player interactions such as Quests, NPC chat, Create branching story with ease, Creating Cinematic with camera paths, and more. It is easily configurable using the web panel specifically designed for this plugin. -The plugin can also be extended using adapters, which are [pre-made](https://gabber235.github.io/TypeWriter/docs/adapters#pre-made-adapters) or can be custom-made by developers. +The plugin can also be extended using adapters, which are [pre-made](https://docs.typewritermc.com/docs/adapters#pre-made-adapters) or can be custom-made by developers. To get started with Typewriter, see the [Getting Started](#getting-started) section. @@ -21,15 +20,15 @@ Thanks to the following sponsors for supporting this project: ### Examples -![cinematic](readme/cinematic.gif) +![cinematic](https://raw.githubusercontent.com/gabber235/TypeWriter/develop/readme/cinematic.gif) A cinematic fully in vanilla minecraft using Typewriter. View a demo [here](https://youtu.be/1pGBtJleEuQ). -![dialogue sequence](readme/chat-messages.gif) +![dialogue sequence](https://raw.githubusercontent.com/gabber235/TypeWriter/develop/readme/chat-messages.gif) A dialogue sequence with Typewriter where the player is asked to choose between multiple options. -![web panel](readme/typewrite-interface-demo.png) +![web panel](https://raw.githubusercontent.com/gabber235/TypeWriter/develop/readme/typewrite-interface-demo.png) The web panel for Typewriter, where you can create quests, NPCs, and more. @@ -39,26 +38,26 @@ The web panel for Typewriter, where you can create quests, NPCs, and more. - Create cinematic sequences with camera movements, dialogue, animated NPCs, and more... - Configure interactions using a custom written visual interface - Extend the plugin using adapters - - [Pre-made adapters](https://gabber235.github.io/TypeWriter/docs/adapters#pre-made-adapters) available for popular plugins + - [Pre-made adapters](https://docs.typewritermc.com/docs/adapters#pre-made-adapters) available for popular plugins - Custom adapters can be made by developers ## Getting started -To get started with Typewriter, simply download the [plugin](https://github.com/gabber235/TypeWriter/releases) and configure it accordingly. -See [Installation Guide](https://gabber235.github.io/TypeWriter/docs/installation-guide) for more information. +To get started with Typewriter, simply download the [plugin](https://modrinth.com/plugin/typewriter/versions) and configure it accordingly. +See [Installation Guide](https://docs.typewritermc.com/docs/installation-guide) for more information. Also be sure to download PacketEvents from [here](https://modrinth.com/plugin/packetevents/versions?l=paper). Then, use the app to configure your custom interactions as desired. -You can also utilize the [pre-made adapters](https://gabber235.github.io/TypeWriter/docs/adapters#pre-made-adapters) or create your own custom adapters to extend the -capabilities of the plugin. See [First Interaction](https://gabber235.github.io/TypeWriter/docs/first-interaction) for more information. +You can also utilize the [pre-made adapters](https://docs.typewritermc.com/docs/adapters#pre-made-adapters) or create your own custom adapters to extend the +capabilities of the plugin. See [First Interaction](https://docs.typewritermc.com/docs/first-interaction) for more information. ## For administrators As an administrator, you can easily configure Typewriter using the custom web panel. Simply input your desired interactions and let the plugin handle the rest. -You can also take advantage of the [pre-made adapters](https://gabber235.github.io/TypeWriter/docs/adapters#pre-made-adapters) or create your own custom +You can also take advantage of the [pre-made adapters](https://docs.typewritermc.com/docs/adapters#pre-made-adapters) or create your own custom adapters to further customize the plugin for your server. ## For developers diff --git a/build-all.sh b/build-all.sh deleted file mode 100755 index d4c6fd01bd..0000000000 --- a/build-all.sh +++ /dev/null @@ -1,31 +0,0 @@ -#!/usr/bin/env bash -# Go to current working directory -WORKING_DIR="$(pwd)" -cd "$WORKING_DIR" - -# Build flutter web -cd ./app || exit -echo "Building flutter web..." -flutter build web || exit -cd "$WORKING_DIR" || exit - -# Build plugin -cd ./plugin || exit -echo "Building plugin" -gradle clean buildRelease || exit -cd "$WORKING_DIR" || exit - -# Build adapters -# list all directories in "./adapters" -for adapter in ./adapters/*; do - # check if it's a directory - if [ -d "$adapter" ]; then - # go to adapter directory - cd "$adapter" || exit - echo "Building adapter: $adapter" - # build adapter - gradle clean buildRelease || exit - # go back to working directory - cd "$WORKING_DIR" || exit - fi -done \ No newline at end of file