Skip to content

Psych-Slice/P-Slice

Repository files navigation

Contributors Forks Stargazers Issues MIT License


Logo

P-Slice Engine

Crossover between Psych Engine and newer versions of FNF (also known as V-Slice)
Explore the Wiki »

· Report Bug or Request Feature · Create Pull Request

Made With

About

P-Slice engine is a crossover between Psych engine and the newest Friday Night Funkin.

It's meant to bring new visuals and features from newer versions of FNF and make changes to the existing ones to make them feel closer to the ones in the V-Slice.

(back to top)

Features

  • V-Slice's freeplay menu (with support for freeplay colors) Freeplay Menu With Color
  • Results screen alt text
  • Character selector alt text
  • Pausable cutscenes alt text
  • Pico alt text

Modding capabilities

custom stickers

Mods made for P-Slice can select which sticker pack and set to use on the next sticker transition.

setPropertyFromClass("substates.StickerSubState", "STICKER_SET", "sticker-set-1") defines which sticker set to use (it's the name of one of the directories in images/transitionSwag/)

setPropertyFromClass("substates.StickerSubState", "STICKER_PACK", "all") defines a pack of stickers to use from the current set. If such pack doesn't exist all defined stickers in a ".json" file will be used.

custom freeplay icons

Freeplay supports 3 types of icons:

  • FNF pre 0.3 (using character's head icon)
  • FNF 0.3+ (located in images/freeplay/icons/{charId}pixel.png)
  • FNF 0.5+ (sparrow sprite located in images/freeplay/icons/{charId}pixel with .PNG and .XML files)

{charId} is the name of the character icon.

registry folder

Mods can contain a registry folder containing entries for P-Slice's registry system (structure is the same as in V-Slice)

They're used to implement custom characters and custom Freeplay styles.

custom commercials

If your mod is either is global or loaded as the first mod, you can add additional commercials in videos/commercials to be used an AttractState

(back to top)

Getting Started

Pre-built Engine can be download from GameBanana. Also, Nightly/Beta Build can be download from Github Actions. (You needs to make a Github account.)

If you wanna compile this Engine, Please check out Here

Building

Dependencies

  • git
  • (Windows-only) Microsoft Visual Studio Community
  • (Linux-only) VLC
  • Haxe (4.3.6 or greater)

(If you are using windows) After installing git, it is RECOMMENDED that you open up a command prompt window and type the following

curl -# -O https://download.visualstudio.microsoft.com/download/pr/3105fcfe-e771-41d6-9a1c-fc971e7d03a7/8eb13958dc429a6e6f7e0d6704d43a55f18d02a253608351b6bf6723ffdaf24e/vs_Community.exe
vs_Community.exe --add Microsoft.VisualStudio.Component.VC.Tools.x86.x64 --add Microsoft.VisualStudio.Component.Windows10SDK.19041 -p

head into the setup folder located in the root directory of this repository, and execute the setup script:

  • Windows.bat for Windows.
  • Unix.sh for Mac/Linux.

Run

lime test <platform>

where <platform> gets replaced with windows, linux, or mac (I also like to add -final flag, but you should be fine without it)

(back to top)

Contributing

Branches

master is the repository's main branch. It contains a PE 1.0 flavor of P-Slice and is the most maintained version.

pe-1.0 is the older branch, which is no longer supposed. I don't recommend using it.

pe-0.6.3 works the same way, but built on Psych 0.6.3. Note that it may contain some bugs not present in the master version.

(back to top)

License

Distributed under the Apache License 2.0. See Licence for more information.

(back to top)