Skip to content

Latest commit

 

History

History
110 lines (82 loc) · 3.82 KB

README.md

File metadata and controls

110 lines (82 loc) · 3.82 KB
Raw

LayTea MIT License Build and release

Work-in-progress modding tools for games of the "Professor Layton".

Features

🎮 Games:

📃 Formats:

  • Professor Layton - London Life (US only):
    • DARC containers: read and write.
    • DENC containers: read and write.
    • ARCHIVE containers: read and write.
    • DENC-LZSS compression: decompress and compress.
    • LZX compression: decompress.
    • MSG texts: read and write.
      • PO export and import.
    • ACL palettes: read.
    • ACG and ACB pixels: read.
    • ASC screen maps: read.
    • NCCL palettes: read.
    • NCCG pixels: read.
    • NCSC screen maps: read.

Documentation

Feel free to ask any question in the project Discussion site!

Check our on-line documentation for more information about the file formats and how to use the tools.

Tool installation

  1. Install .NET 8.0
  2. Install the latest version of the tool: dotnet tool install -g LayTea
    • You can update it with dotnet tool update -g LayTea
    • To use preview versions, add the argument --prerelease --add-source https://pkgs.dev.azure.com/SceneGate/SceneGate/_packaging/SceneGate-Preview/nuget/v3/index.json

Library usage

The project delivers a programming .NET (C#) library with the support of the formats. You can use this library to create programs that manipulates the game assets.

  • SceneGate.Games.ProfessorLayton

Stable releases are published in nuget.org.

Preview releases can be found in this Azure DevOps package repository. To use a preview release, create a file nuget.config in the same directory of your solution (.sln) file with the following content:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <packageSources>
    <clear/>
    <add key="nuget.org" value="https://api.nuget.org/v3/index.json" />
    <add key="SceneGate-Preview" value="https://pkgs.dev.azure.com/SceneGate/SceneGate/_packaging/SceneGate-Preview/nuget/v3/index.json" />
  </packageSources>
  <packageSourceMapping>
    <packageSource key="nuget.org">
      <package pattern="*" />
    </packageSource>

    <packageSource key=" SceneGate-Preview">
      <package pattern="Yarhl*" />
      <package pattern="SceneGate.*" />
      <package pattern="Texim" />
    </packageSource>
  </packageSourceMapping>
</configuration>

Contributing

The repository requires to build .NET 8.0 SDK.

To build, test and generate artifacts run:

# Build and run tests
dotnet run --project build/orchestrator

# (Optional) Create bundles (nuget, zips, docs)
dotnet run --project build/orchestrator -- --target=Bundle

Additionally you can use Visual Studio or JetBrains Rider as any other .NET project.

To contribute follow the contributing guidelines.

License

The software is licensed under the terms of the MIT license. The information and software provided by this repository is only for educational and research purpose. Please support the original game developers by buying their games.

Icon by Vincent Le Moign, CC BY 4.0, via Wikimedia Commons.