Using setup.yml to post mods to Scoop - Trail-Blaze/dynamite-core GitHub Wiki

The setup.yml is a file which includes the properties of a package that is posted on the scoop repository.

An example file is shown below:

fn_compat: "10.40" # Version of Fortnite package is compatible with (paks only)
name: "Generic"
version: "1.0.0"
type: "backend/bundle" # Could be either [backend/bundle, backend/binary], PAKCHUNK or DLL. Here it is set as backend/bundle
URL: "https://packages.blazehosted.ml/dynex/generic.zip"
description: "Lorem ipsum Dolor"
publisher_website: "https://example.com" # Optional 
create_shortcut: True # TBD. This property is unsupported at this time

This file is required by the scoop-publisher program in order to publish your module to Scoop.

This file along with the icon of your application should be included in the C:\Blaze\WizardOfRepo\app directory.

Type

The type property is what describes what type of package this is. There are a total of THREE types of packages which can currently be posted to Scoop.

Types

  • Backend
    • backend/binary
    • backend/bundle
  • PAKCHUNK
  • DLL

Backend Type

For backend there are two subtypes which may be put.

  • In the case of backend/binary, it is to be put only when the backend does not consist of loose files/source code. Something like Rift, where everything is encased into a single, compiled executable file.

  • In the case of backend/bundle, it is to be put only when the backend DOES include loose files/source code. Something like Dynamite, where everything is run off of the source code.

Rules Which ALL Backends Must Follow Before Being Posted on Scoop

There is one main rule which must be followed by all backends before being posted on scoop.

The only existing rule at this time is for the backend to include one small file, called bak-release. In this file it should include the following information in the following format.

Also note that ALL backend/bundle packages must be zipped in a .zip file!

name: "Dynamite"
type: "Standard, No-ingame"
rel: "1.42.7"
entrypoint: "node app"

name

The distribution name of your backend.

type

What features/limitations your backend has. In the case of Dynamite it is Standard, No-ingame. In the case of Rift, it is Multiplayer, In-game. It does not really matter what you put here, but it must be short and concise. Here are a few that you can try:

A Few Backend Types

Format Used: feature/limitation, limitation/feature, ...

  • Standard, No-ingame
  • Multiplayer, In-game
  • Dummy, limited functionality
  • Unstable, Breaks
  • Testing
  • Multiplayer, In-game, Works on few versions of Fortnite

rel

What version of backend is this?

entrypoint

What is the filename or command you should run in order to start your backend?

PAKCHUNK

PAKCHUNK is another way Blaze refers to a custom PAK file which is loaded into Fortnite with the filename of pakchunk_NAME-WindowsClient.pak. Use this type if your mod is one of those.

DLL

DLL is another way Blaze refers to a cURL-bypass DLL for Fortnite. Any other DLL that you attach here will not work. All DLLs you attach WILL BE SCANNED FOR MALWARE and you will be banned from posting anymore mods to Blaze if a threat is found.