Skip to content

About

Guides and generated scripting API reference for Mafia Online

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

2 Commits

Folders and files

Repository files navigation

Mafia Online Docs

Authored guides and the generated scripting API reference for Mafia Online.

The game repository owns the C++ bindings and exports an API contract. This repository combines that contract with the guides in guides/, using @mafiahub/services-cli. The site structure is adapted from the Kingdoms Connected docs. The empty IGNORE file keeps Framework's native project discovery from trying to configure this documentation site as a game module.

Local preview

In a Framework checkout containing the Mafia Online project, generate its contract from code/projects/mafia1online:

node scripts/build_scripting_docs.mjs

Then, from this docs repository, build or serve the site:

MAFIAONLINE_CONTRACT_ROOT=../mafia1online/build/scripting-contract npm run build
MAFIAONLINE_CONTRACT_ROOT=../mafia1online/build/scripting-contract npm run dev

The preview runs at http://127.0.0.1:4321. The static site is written to dist/. The CLI package cache and downloaded contracts stay in .cache/.

Once a Mafia Online contract has been published to MafiaHub Services, omit MAFIAONLINE_CONTRACT_ROOT to download it. Set MAFIAONLINE_CONTRACT_CHANNEL to choose a channel, or MAFIAONLINE_CONTRACT_REVISION for an immutable revision. Deployment settings and credentials are configured separately; this repository contains neither.

About

Guides and generated scripting API reference for Mafia Online

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages