RWESharp.Modify.Mod.ModInfo

class RWESharp.Modify.Mod.ModInfo(title: str, id: str, author: str, version: str, description: str = 'No description provided', tags: list[str] = <factory>, required_modules: list[str] = <factory>, required_mods: list[str] = <factory>, mod_class: str = 'NOTFOUND')[source]

Bases: object

ModInfo stores all information about the Mod

Parameters:
__init__(title: str, id: str, author: str, version: str, description: str = 'No description provided', tags: list[str] = <factory>, required_modules: list[str] = <factory>, required_mods: list[str] = <factory>, mod_class: str = 'NOTFOUND') → None
Parameters:
Return type:

None

Methods

__init__(title, id, author, version[, ...])

import_from_file(file)

Imports ModInfo from file

import_from_mod_path(path)

Imports file from mod's path

Attributes

description

Mod Description

mod_class

Mod's class to search through in mod's script

title

Mod Title

id

Mod Id

author

Mod Author

version

Mod Version

tags

Mod Tags

required_modules

Mod's required Modules

required_mods

Mod's required Mods
title: str

Mod Title

id: str

Mod Id

author: str

Mod Author

version: str

Mod Version

description: str = 'No description provided'

Mod Description

tags: list[str]

Mod Tags

required_modules: list[str]

Mod’s required Modules

required_mods: list[str]

Mod’s required Mods

mod_class: str = 'NOTFOUND'

Mod’s class to search through in mod’s script

static import_from_file(file: TextIOWrapper) → ModInfo | None[source]

Imports ModInfo from file

Parameters:

file (TextIOWrapper) – Json file

Returns:

ModInfo if found

Return type:

ModInfo

static import_from_mod_path(path) → ModInfo | None[source]

Imports file from mod’s path

Parameters:

path – Path to mod

Returns:

ModInfo if found

Return type:

ModInfo