-
-
Notifications
You must be signed in to change notification settings - Fork 55
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
060b30d
commit f38e97d
Showing
8 changed files
with
194 additions
and
0 deletions.
There are no files selected for viewing
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
--- | ||
slug: restructured-documentation | ||
title: Restructured documentation | ||
authors: [MartenMrfc] | ||
tags: [docs] | ||
--- | ||
Hey reader, Marten here. Noticed how Gabber235 spends a ton of time on documentation? Well, I thought, why not help out with that so he can focus more on building cool stuff for the plugin? | ||
|
||
If you've been checking out the TypeWriter GitHub page's develop branch lately, you might've seen a bunch of new documentation. The cool part? We set it up to automatically generate whenever I push an update to the development branch. So, guess what? We've got a new documentation with the latest features for you! | ||
{/* truncate */} | ||
|
||
# What got changed? | ||
Let's break down the update: | ||
|
||
* **Easy Version Switching**: Now, you can switch between Typewriter versions effortlessly to find exactly what you need. Super handy for those big updates like 4.0 or 5.0. | ||
|
||
* **Fresh Look**: The documentation got a big update on the layout, matching the vibe of the latest beta version. | ||
|
||
* **More Content, More Fun**: I've thrown in a bunch of new pages for you to read and improve your experience with TypeWriter. | ||
|
||
* **Installation Guide Makeover**: We've revamped the whole installation guide to make your life simpler. Installing the plugin should be a breeze with this new guide by your side. | ||
|
||
The TypeWriter documentation is now much more informative. Check it out, and improve your experience with TypeWriter! |
36 changes: 36 additions & 0 deletions
36
documentation/devlog/2024-07-31-Documentation-improvements.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
--- | ||
slug: documentation-improvements | ||
title: Documentation Improvements | ||
authors: [MartenMrfc] | ||
tags: [docs] | ||
--- | ||
|
||
Hey reader, and fellow members! I've added numerous additions to the documentation. Here's a quick summary: | ||
{/* truncate */} | ||
# 📺 Major Visual Enhancements | ||
## Upgraded Video Player | ||
The video player in our documentation has been completely revamped with custom styles and controls, providing a much-improved user experience. | ||
## Enhanced EntrySearch | ||
The EntrySearch component now redirects you directly to the entry adapter documentation upon clicking an entry, streamlining navigation. | ||
## Improved 404 Page | ||
Our 404 page has been redesigned for a more polished and user-friendly appearance. | ||
|
||
# ✨ New Features | ||
* **Difficulty Levels**: Each page now displays its difficulty level at the top, making it easier to understand the complexity of the content at a glance. | ||
* **Last Updated Information**: The bottom of each page now shows the last edit date, helping you track the most recent updates. | ||
|
||
# 📚 New Documentation Pages | ||
I've added several new pages for you to explore: | ||
- Conditional Dialogue | ||
- First Join Cinematic | ||
- Interacting with an Entity | ||
- Road Network | ||
|
||
# 🛠️ Tweaks and Fixes | ||
- Added video converter to the .vscode folder | ||
- Added build/develop scripts to the .vscode folder | ||
- Removed unused imports | ||
- Added light theme to EntrySearch | ||
- Included new metadata | ||
|
||
You can explore all these updates in our [beta documentation](https://docs.typewritermc.com/beta/docs/home)! |
File renamed without changes.
25 changes: 25 additions & 0 deletions
25
documentation/devlog/releases/2023-07-18-0.3.0-release.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
slug: 0.3.0-release | ||
title: Cinematics Update | ||
authors: [gabber235] | ||
tags: [release] | ||
--- | ||
import Player from "@site/src/components/Player"; | ||
|
||
# Introducing Typewriter v0.3: The Cinematics Update! | ||
|
||
Hey reader, Get ready to bring your Minecraft server to life with the most exciting update since Typewriter's release. We've been hard at work, and this update is packed with game-changing features, led by the introduction of Cinematics 🎬. | ||
|
||
{/* truncate */} | ||
|
||
## What are cinematics? | ||
|
||
Cinematics are the ultimate tool for creating immersive experiences in your Minecraft world. With precisely timed sequences of actions, you can now craft stunning cutscenes for quests, engaging tutorials, fast travel systems, thrilling random encounters, and so much more. The possibilities are endless ✨! | ||
|
||
But that's not all. Cinematics in Typewriter go above and beyond. You can create dynamic camera paths to capture the perfect angles 🎥, weave in captivating dialogues for your characters 🎭, and even record your own NPC 💃 to take center stage in your cinematic masterpiece. | ||
|
||
With over `28,131 lines` changed and ```10,988 lines``` removed, this is the biggest update to Typewriter yet. We've fine-tuned every aspect to ensure a seamless and powerful cinematic experience that will leave your players in awe. | ||
|
||
So, gather your creative spirit, update your Typewriter plugin, and get ready to embark on a new era of storytelling in Minecraft. We can't wait to see the incredible cinematic adventures you'll create with Typewriter v0.3. Enjoy the journey 🌟🎮! | ||
|
||
<iframe width="560" height="315" src="https://www.youtube.com/embed/1pGBtJleEuQ?si=H_nY1nEikf6xu6VV" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe> |
22 changes: 22 additions & 0 deletions
22
documentation/devlog/releases/2024-01-08-0.4.0-release.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
--- | ||
slug: 0.4.0-release | ||
title: Quality of life update | ||
authors: [gabber235] | ||
tags: [release] | ||
--- | ||
|
||
Hey reader, hope you have had a great start to the new year! To make it even sweeter, the next version of **Typewriter** is here: _**The Quality of life update**_ | ||
{/* truncate */} | ||
|
||
|
||
## What's new in 0.4.0? | ||
It may seem like a small update, but with 24,957 lines added and 17,267 lines removed it is packing some great improvements. To give you a short list: | ||
|
||
### Major Changes | ||
- **Item Inspector**: Now items are more flexible and easier to use in the ui. It also add the ability for NBT data. | ||
- **Revamp CI/CD**: Allow quick dev-builds to release early and allow users to test the plugin. | ||
- **Chapters**: Finally there is a way to order pages. | ||
- **Custom Sounds**: Allow users to have custom sounds. | ||
- **Muli-Command**: Allow multiple commands to be specified in a single entry. | ||
- **Drag & Drop for pages & entries**: Allow you to drag and drop entries onto each other for quick linking. | ||
- And 23 other improvements & bug fixes |
47 changes: 47 additions & 0 deletions
47
documentation/devlog/releases/2024-08-10-0.5.0-release.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
--- | ||
slug: 0.5.0-release | ||
title: Manifesting Stories Update | ||
authors: [gabber235] | ||
tags: [release] | ||
--- | ||
|
||
# Manifesting Stories Update | ||
|
||
Since this update is so big, it is almost impossible to list every change. Therefore, only the biggest changes are listed. | ||
|
||
With **729** commits, **1,438** changed files, with **60,258** additions and **33,483** deletions, this is by far the biggest update in the history of Typewriter. | ||
{/* truncate */} | ||
## Manifest Entries | ||
Manifest entries are entries that automatically do stuff based on the environment. Think of showing NPCs based on filters (such as quest status) and having NPC holograms. Boss bars, Creating scoreboards, Interaction zones, and much more! | ||
|
||
_For the programmers under us, where sequence entries are like imperative programming. Manifest entries are declarative programming. They can be linked in an acyclic-directional graph._ | ||
|
||
### Audience Entries | ||
The first subclass of Manifest Entries are Audience Entries. | ||
They display anything to the player, Such as a boss bar. There is a special variety of audience entries, which are AudienceFilterEntries. They filter out players, such as regions, if they are in a certain part of a quest, if they are in a cinematic... | ||
These types of filters can be chained to have extreme customizability and flexibility. | ||
|
||
## Entity Adapter | ||
Say goodbye to the old NPC adapters like Citizens, FancyNpcs, and ZNPCs. The Entity Adapter allows you to define entities directly within Typewriter, empowering you to use them in cinematics, control their visibility based on conditions (like during a quest segment), and even have them navigate and exhibit complex behaviors. With full control, the sky is the limit! | ||
<iframe width="560" height="315" src="https://www.youtube.com/embed/Ny-OhrV5FQQ?si=dqzetbInKE6jxRjy" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe> | ||
## Road Network | ||
You can now create **Road Networks** in Typewriter. | ||
These allow NPCs to navigate through the world and show Path Streams to guide the players. | ||
<iframe width="560" height="315" src="https://www.youtube.com/embed/uVKGS70PEq4?si=FdXpg4lVTRMtU7lu" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe> | ||
## Grouped Facts | ||
The value of a fact can now be set for a group of players. | ||
For example, you can now check if a party of players have killed a certain number of enemies. | ||
|
||
## Documentation Improvements | ||
Some of you may have already looked at the new documentation. | ||
We've made major improvements to the documentation. All to make it easier to use and understand Typewriter. | ||
|
||
## Switched from ProtocolLib to PacketEvents | ||
This switch has allowed many new features in Typewriter, like the new buttery smooth camera cinematics. It means that now you need to install PacketEvents in order for Typewriter to work. | ||
|
||
## Made some breaking API changes | ||
There are various breaking API changes for Adapters. To view the migration, take a look at the [Migration Guide](https://docs.typewritermc.com/develop/adapters/api-changes/0.5.0) | ||
|
||
:::danger[Deprecation Warning] | ||
With this release, we're marking the old NPC adapters, such as ZNPCs and FancyNpcs, as deprecated. This means that while they will still function in the current version, this will be the last release where they are supported. Though only the files added here will work. Going forward, we'll only be providing bug fixes for the Citizens NPC adapter. It will remain updated primarily to assist new users in getting started, but we strongly encourage everyone to transition to the Entity Adapter for the best Typewriter experience. | ||
::: |
41 changes: 41 additions & 0 deletions
41
documentation/devlog/releases/2024-09-11-0.6.0-release.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
--- | ||
slug: 0.6.0-release | ||
title: Extension Update | ||
authors: [gabber235] | ||
tags: [release] | ||
--- | ||
|
||
# Typewriter v0.6 – The Extensions Update | ||
|
||
This release brings a foundational shift in Typewriter’s core structure and a major update to the item system, along with new features and important usability improvements. Below are the highlights: | ||
{/* truncate */} | ||
|
||
## Critical Changes | ||
|
||
### From Adapters to Extensions | ||
Typewriter has transitioned from using `Adapters` to `Extensions`, marking a significant evolution in how custom functionality is integrated. Key improvements with this change include: | ||
- **Gradle Plugin for Extensions**: A new Gradle plugin simplifies the process of developing Extensions, making setup and management easier for developers. | ||
- **Compile-Time Discovery**: Discovery of Extension internals, such as entries, now occurs at compile-time instead of runtime. This not only future-proofs Typewriter but also lays the groundwork for the upcoming marketplace, where entries in each Extension will be viewable without running the Extension. | ||
- **Hot Reloading**: Extensions can now be reloaded on-the-fly using `/tw reload`, enabling real-time updates without the need for a server restart. | ||
- **Optimized Loading**: Only the necessary classes are loaded from Extensions. For example, if an Extension contains thousands of entries but only one is used, Typewriter loads only that specific entry, enhancing memory and processing efficiency. | ||
- **Extension Validators**: Built-in validators now check Extensions against Typewriter’s standards, helping to ensure reliability and consistency across user-created Extensions. | ||
|
||
### New Item System | ||
Typewriter introduces a completely new item system, which is **incompatible with previously defined items**. Users will need to recreate items to align with the new structure. Based on user feedback, no migrator will be provided, as the majority found it unnecessary. **Please test this update on a development server before upgrading your production environment.** | ||
|
||
## Important Features | ||
|
||
1. **Skip Cinematic Segments** | ||
A new `SkipCinematicEntry` gives players the option to skip sections of cinematics by pressing a configured key, offering more control over in-game cinematic experiences. | ||
|
||
2. **UI and Web Panel Upgrades** | ||
Improvements to the web panel and UI components provide a smoother experience. These upgrades include the ability to unselect Sound IDs, layout enhancements, compatibility improvements behind reverse proxies, and visual indicators for empty fields, all of which contribute to a more intuitive and flexible panel. | ||
|
||
## New Entries | ||
|
||
- **Cinematic Entries**: `GameTimeCinematicEntry`, `WeatherCinematicEntry`, `SkipCinematicEntry`, `BlockCommandCinematicEntry` | ||
- **Dialogue**: `ActionbarDialogueEntry`, `SimpleMessageActionEntry` | ||
- **Entity and Activity Entries**: `MythicMobKillPlayerEventEntry`, `RemovePotionEffectActionEntry`, `LookAtBlockActivity`, `LookAtPitchYawActivity`, `RandomPatrolActivity`, `AmbientSoundActivity`, `ScaleData`, `InteractionEntity`, `PillagerEntity`, `VindicatorEntity`, `Llama Entity` | ||
- **Miscellaneous**: `WeatherAudienceEntry`, `FireworkActionEntry` (with `flight duration` setting) | ||
|
||
**If you consider Typewriter to be valuable to your server, please consider [Sponsoring the Project](https://github.com/sponsors/gabber235)** |