ForgeTomlScanner 8.0.5 API

All Implemented Interfaces:: de.griefed.serverpackcreator.api.modscanning.Scanner


public class ForgeTomlScanner
 implements Scanner<Pair<Collection<File>, Collection<Pair<String, String>>>, Collection<File>>

mods.toml-based scanning of Forge-Minecraft mods for Minecraft 1.16.5 and newer.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`modsToml`
`private final Regex`	`neoForgeMinecraft`
`private final Regex`	`bothServer`

Constructor Summary

Constructors
Constructor	Description
`ForgeTomlScanner(TomlParser tomlParser)`

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`String`	`getModsToml()`
`final Regex`	`getNeoForgeMinecraft()`
`final Regex`	`getBothServer()`
`Pair<Collection<File>, Collection<Pair<String, String>>>`	`scan(Collection<File> jarFiles)`	Scan the `mods.toml`-files in mod JAR-files of a given directory for their sideness.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ForgeTomlScanner
```
ForgeTomlScanner(TomlParser tomlParser)
```
    Parameters:
    
    tomlParser - To parse .toml-files.
- Method Detail
  - getModsToml
```
 String getModsToml()
```
  - getNeoForgeMinecraft
```
 final Regex getNeoForgeMinecraft()
```
  - getBothServer
```
 final Regex getBothServer()
```
  - scan
```
 Pair<Collection<File>, Collection<Pair<String, String>>> scan(Collection<File> jarFiles)
```
    Scan the mods.toml-files in mod JAR-files of a given directory for their sideness.
    If mods specifies side=BOTH|SERVER, it is added.
    If dependencies.modId for Forge|Minecraft specifies side=BOTH|SERVER , it is added.
    Any modId of a dependency specifying side=BOTH|SERVER is added.
    If no sideness can be found for a given mod, it is added to prevent false positives.
    
    Parameters:
    
    jarFiles - A list of files in which to check the mods.toml-files.
    
    Returns:
    
    Mods not to include in server pack based on mods.toml-configuration.