Start Here! - TootieJin/pjsekai-overlay-APPEND GitHub Wiki

Requirements

AviUtl AviUtl ExEdit2 (Recommended)
AviUtl + Advanced Editing plug-in + L-SMASH Works + easymp4 (JP Installation Guide)
- JP installer: AviUtl JP Installer Script
- EN installer: AviUtl EN Extra Pack

Import all plugins to aviutl\Plugins folder
AviUtl ExEdit2 (via installer) + L-SMASH Works + MP4Exporter
- English language can be selected in 設定 > 言語の設定 > English (Settings > Language > English)

Import AviUtl2\lwinput.aui2 & MP4Exporter.auo2 plugin to C:\ProgramData\aviutl2\Plugin folder

Video Guide

You'll need a clean recording that has BLACK background & ALL UI hidden (including lanes) like in the screenshot below:

Follow the steps below:

  1. Go to Sonolus to find your chart.
  2. Screen record the video with BLACK Background, Stage OFF, Hide UI ON or ALL

Note

To change the background, go to Configuration > Background > Select

  1. Transfer the video file to your computer.
  2. (AviUtl ONLY) Download the FFmpeg encoder and use it (ffmpeg -i source.mp4 output.mp4)
    • This step is required because of a funny bug only seen in AviUtl: If the frame rate of the source video does not match the project, synchronization is delayed.
    • Alternatively, you can use your video editor to do this step.
  3. Once done, refer to the usage guide below.

Usage Guide

  1. Install AviUtl & other plugins
  2. Download the latest version of pjsekai-overlay-APPEND here.
    • (optional) You can download extra-assets.zip for use of non-essential assets.
  3. Unzip the file in a directory that doesn't contain non-ASCII characters nor require administrative permissions (see #5)
  4. Follow the steps based on which AviUtl you want to use:
AviUtl AviUtl ExEdit2
1. While aviutl.exe is open, open pjsekai-overlay-APPEND.exe
2. Restart AviUtl to apply changes.
1. Open pjsekai-overlay-APPEND.exe
2. Press 2 to choose the AviUtl ExEdit2 instance
  1. In your pjsekai-overlay-APPEND.exe command prompt, input the chart ID including the prefix.
  1. Create a new project in AviUtl with Image size 1920x1080 (or 1440x1080) & Frame rate 60
AviUtl AviUtl ExEdit2
Right click anywhere in the Advanced Editing window > Create a New Project

image
Go to File > New Project

image
  1. Import specified exo/alias(.object) file by navigating to your pjsekai-overlay-APPEND\dist\[Chart ID] directory:
AviUtl AviUtl ExEdit2
16:9 - EN ver:
main_en_16-9_1920x1080.exo
v1-skin_en_16-9_1920x1080.exo
- JP ver:
main_jp_16-9_1920x1080.exo
v1-skin_jp_16-9_1920x1080.exo
main2_16-9_1920x1080.object
v1-skin2_16-9_1920x1080.object
4:3 - EN ver:
main_en_4-3_1440x1080.exo
v1-skin_en_4-3_1440x1080.exo
- JP ver:
main_jp_4-3_1440x1080.exo
v1-skin_jp_4-3_1440x1080.exo
main2_4-3_1440x1080.object
v1-skin2_4-3_1440x1080.object
  1. Select a video file in the timeline provided by the exo/alias(.object)
AviUtl AviUtl ExEdit2
1. Double click Video file[Standard drawing]

image

2. Click Reference file, then select a video file

image
1. Click Video file

image

2. Click File, then select a video file

image
  1. Adjust the video & audio positioning as necessary. Make sure the video frame matches the slot particle with the lane
image
  1. Go to Root@pjsekai-overlay and adjust the Offset
image
  1. Once finished, export your video as mp4
  • AviUtl: File > Export with Plugin > かんたんMP4出力 or File > Export with Plugin > Adv. x264/x265 Export(GUI) Ex
  • AviUtl ExEdit2: File > Export > MP4 Exporter (by えすご/Esugo)

UI Customization Specifications

Tip

You can change default values in default.ini, reducing the need to change values in AviUtl.

image

Root@pjsekai-overlay-en

image
Name Description Default Range
Offset
offset
Number of frames to shift events
- Increase to shift timing later
- Decrease to shift timing earlier
216.00 -99999.99 ~ 99999.99
Cache
cache
When cache is set to 0, any change in the data.ped is applied immediately
(0 - OFF, 1 - ON)
1 0 or 1
Text Language
text_lang
Set text language configuration for the error & detailed stats text
(0 - 日本語, 1 - English)
0 0 or 1
Watermark
watermark
Enable watermark text at the bottom-left corner 1 (ON) 0 or 1
Detailed Stats
detail_stat
image
View detailed statistics (useful for measuring & analysing). This text will not be shown when exporting
0 (OFF) 0 or 1

Life@pjsekai-overlay-en

LifeUP life-v1 life

Name Description Default Range
LIFE
life
LIFE value (self-explanatory)
- When value changes, the LIFE bar changes as well
1000 0 ~ 9999 (Integer)
Skill Effect
life_skill
Toggle skill glow effect 0 (OFF) 0 or 1
Overflow LIFE Bar
overflow
life_overflow-v1
life_overflow
0 (OFF) 0 or 1
Leading Zero
lead_zero
Append the "0" digits for LIFE value below 1000 0 (OFF) 0 or 1

Score@pjsekai-overlay-en

ScoreUP bg

Name Description Default Range
Min Digit
min_digit
Render the minimum amount of digits in score 8 1 ~ 99 (Integer)
Skill Effect
score_skill
Toggle skill glow effect
0: OFF
1: AUTO - For each skill event, show skill glow effect for 5 seconds
2: ON
1 0 ~ 2 (Integer)
Animation Speed
score_speed
Adjust animation speed 1.00 >= 0
Animated Scoring
anim_score
Increase incrementally rather than all at once 0 (OFF) 0 or 1
WDS animation
wds_anim
Toggle World Dai Star's added score animation 0 (OFF) 0 or 1

Tip

You can add skill events to use the AUTO Skill Effect. Go to your data.ped file and for each skill event you want to add, add the line s|[timeframe (seconds)]. You can add this as many as you want.

  • Example:
image

Combo@pjsekai-overlay-en

pt nt

Name Description Default Range
AP Combo
ap
Toggle AP Combo status 1 0 or 1
Combo Tag
tag
Toggle rendering combo tag 1 0 or 1
Show the last X digit(s)
last_digit
4: 12345 -> /2345
2: 12345 -> ///45
4 >= 0 (Integer)
Animation Speed
combo_speed
Adjust animation speed 1.00 >= 0
n00 Combo Burst
combo_burst
Toggle World Dai Star's combo burst effect 0 (OFF) 0 or 1
Achievement Rate
achievement_rate
image
Toggle Achievement Rate displayed on top of the combo counter (Set to 0 or leave it blank to turn it OFF)

Extra features:
100.0000+: Increase incrementally (like Animated Scoring) up to 100.0000%
100.0000-: Start at 100.0000%, then decrease for non-perfect judgements
100.0000 Valid floating number

Judgement@pjsekai-overlay-en

SkillUP
Name Description Default Range
Judge Type
judge
1: perfect
2: great
3: good
4: bad
5: miss
6: auto
7 ~ 10: Custom judgements
1 1 ~ 10 (Integer)
Animation Speed
judge_speed
Adjust animation speed 1.00 >= 0

Common Problems

Changing system locale

Change your system locale to Japanese (Japan): Settings > Time & Language > Language > Administrative language settings > "Administrative" tab > Change system locale...

image

Installing a language pack

The animation slowing down when importing

Go to File > New Project and set frame rate to 60. The change will be reflected in future imports.

image

The UI doesn't show anything / PED file unable to be opened

You likely haven't selected a data.ped file.

  • AviUtl: Locate your data.ped in the pjsekai-overlay-APPEND\dist\[Chart ID] directory & copy the path to the Root@pjsekai-overlay-en > Setting > PED File Path. (Make sure to replace \ (¥) with either \\ (¥¥) or /).
image
  • AviUtl ExEdit2: Go to Root@pjsekai-overlay-2, select PED File, then select data.ped in the pjsekai-overlay-APPEND\dist\[Chart ID] directory
image

The intro doesn't load all objects

AviUtl for whatever reason stops loading when importing for the first time. If that is the case, you may have to import it again.

The fonts look off/incorrect

Project Sekai uses the RodinNTLG DB + EB font (described in Requirements). These are paid fonts so we're not allowed to show you how to install it.

image

Still have questions or encountering problems?

Make a discussion thread.

⚠️ **GitHub.com Fallback** ⚠️