Logs & Diagnostics: Difference between revisions
No edit summary |
No edit summary |
||
| Line 5: | Line 5: | ||
}} | }} | ||
__TOC__ | |||
Welcome to the Lumiose Online diagnostic documentation. | |||
This page explains how to collect diagnostic information when troubleshooting installation failures, launcher errors, game crashes, multiplayer connectivity problems, and other technical issues. | |||
Diagnostic logs help the development team identify where a failure occurred and determine which components may be responsible. | |||
{{Notice | |||
|type=info | |||
|title=Platform Differences | |||
|The diagnostic files described below are primarily associated with the Windows standalone launcher (ZA Recomp). Other platforms may generate different logs or use different diagnostic methods. | |||
}} | |||
== Supported Platforms == | == Supported Platforms == | ||
Lumiose Online supports four | Lumiose Online supports four installation methods: | ||
{| class="wikitable" | |||
! Platform | |||
! Installation Method | |||
! Diagnostic Information | |||
|- | |||
| Windows | |||
| ZA Recomp (Native) | |||
| Launcher, gameplay, compilation, and crash logs | |||
|- | |||
| macOS | |||
| MonZaMac (Native) | |||
| Platform-specific diagnostic information | |||
|- | |||
| PC | |||
| Eden Emulator | |||
| Emulator and mod-related diagnostics | |||
|- | |||
| Nintendo Switch | |||
| Atmosphère | |||
| Platform-specific diagnostic information | |||
|} | |||
The availability and location of diagnostic logs depend on the platform, application version, and type of failure. | |||
== Windows Standalone Launcher (ZA Recomp) == | |||
The Windows standalone launcher can generate several diagnostic files during installation, game preparation, and execution. | |||
=== Diagnostic Log Reference === | |||
= | {| class="wikitable" | ||
! Log File | |||
! Purpose | |||
! Useful For | |||
|- | |||
| '''play.log''' | |||
| Records game execution and runtime events. | |||
| Startup failures, gameplay problems, runtime errors | |||
|- | |||
| '''crash.log''' | |||
| Records crash-related diagnostic information when available. | |||
| Application crashes, exceptions, access violations | |||
|- | |||
| '''smoke.log''' | |||
| Records diagnostic output associated with isolated startup or preparation checks. | |||
| Isolated startup failures, update preparation problems | |||
|- | |||
| '''capture.log''' | |||
| Records diagnostic output associated with preparation or capture operations. | |||
| Update preparation and related failures | |||
|} | |||
Not every installation or failure will generate all of these files. | |||
=== play.log === | === play.log === | ||
| Line 30: | Line 81: | ||
The '''play.log''' file records information about game execution. | The '''play.log''' file records information about game execution. | ||
Depending on the launcher version, it may contain: | |||
* | * ZA Recomp version information | ||
* | * Windows version | ||
* CPU and system information | |||
* Game initialization events | * Game initialization events | ||
* Runtime errors | * Launcher status messages | ||
* Runtime warnings and errors | |||
'''When to collect:''' | |||
* The game fails to launch. | |||
* The game starts but encounters errors. | |||
* Gameplay behaves unexpectedly. | |||
* The launcher displays a runtime error. | |||
When possible, reproduce the issue and collect the log from the affected session. | |||
=== crash.log === | === crash.log === | ||
| Line 45: | Line 105: | ||
Depending on the failure, it may contain: | Depending on the failure, it may contain: | ||
* Exception | * Exception codes | ||
* | * Faulting memory addresses | ||
* | * Host backtraces | ||
* Crash-related diagnostic | * Guest function references | ||
* Crash-related diagnostic information | |||
For example, an exception code such as '''0xC0000005''' indicates an access violation. | |||
An access violation alone does not establish the underlying cause. Additional logs and system information may be required. | |||
'''When to collect:''' | |||
* The game closes unexpectedly. | |||
* The launcher or game crashes during startup. | |||
* The game crashes during gameplay. | |||
* An exception or backtrace is generated. | |||
{{Notice | |||
|type=tip | |||
|title=Crash Investigation | |||
|When reporting a crash, include both crash.log and play.log if available. The execution log may provide context about events immediately preceding the crash. | |||
}} | |||
=== smoke.log === | |||
The '''smoke.log''' file can contain diagnostic information associated with isolated startup or preparation checks. | |||
This log may be relevant when the launcher reports errors such as: | |||
* Update preparation failed | |||
* Isolated startup did not finish | |||
* Game preparation or validation failed | |||
'''When to collect:''' | |||
Collect this log when an installation or update preparation operation fails and the file is available. | |||
=== capture.log === | |||
The '''capture.log''' file can contain diagnostic information associated with preparation or capture operations. | |||
It may be useful when investigating: | |||
* Update preparation failures | |||
* Game preparation errors | |||
* Failures occurring before normal gameplay begins | |||
'''When to collect:''' | |||
Collect this log alongside smoke.log when investigating an update preparation failure, if both files were generated. | |||
{{Notice | |||
|type=info | |||
|title=Diagnostic Log Availability | |||
|Some logs are only generated during specific operations or failure conditions. A missing log file does not necessarily indicate an installation problem. | |||
}} | |||
== Which Logs Should I Collect? == | |||
Use the following table to identify the most relevant diagnostic files for a reported issue. | |||
{| class="wikitable" | |||
! Problem | |||
! Recommended Logs | |||
|- | |||
| Game fails to start | |||
| play.log, crash.log if generated | |||
|- | |||
| Game crashes during gameplay | |||
| crash.log, play.log | |||
|- | |||
| Update preparation fails | |||
| smoke.log, capture.log | |||
|- | |||
| Isolated startup did not finish | |||
| smoke.log, capture.log | |||
|- | |||
| Game import fails | |||
| Relevant launcher or import diagnostic output | |||
|- | |||
| Multiplayer connection fails | |||
| play.log and any relevant connection error messages | |||
|- | |||
| Performance problems | |||
| play.log, hardware specifications, and graphics settings | |||
|} | |||
== Collecting Logs == | These recommendations apply primarily to the Windows standalone launcher. | ||
== Other Platforms == | |||
=== MonZaMac (macOS) === | |||
MonZaMac provides a native macOS implementation of Pokémon Legends: Z-A. | |||
Diagnostic information may differ from the Windows launcher. | |||
When reporting a problem, provide: | |||
* macOS version | |||
* Mac model and Apple Silicon chip | |||
* MonZaMac release version | |||
* Exact error messages | |||
* Available application logs or crash reports | |||
=== Eden Emulator (PC) === | |||
Eden uses its own emulation environment and diagnostic facilities. | |||
When reporting a Lumiose Online issue while using Eden, provide: | |||
* Eden version | |||
* Operating system | |||
* Pokémon Legends: Z-A game version | |||
* Lumiose Online mod version | |||
* Exact error messages | |||
* Relevant diagnostic information, if available | |||
{{Notice | |||
|type=info | |||
|title=Emulator Support | |||
|Problems originating from the emulator itself may require assistance from the Eden development or support community rather than the Lumiose Online development team. | |||
}} | |||
=== Nintendo Switch (Atmosphère) === | |||
Nintendo Switch installations use Atmosphère custom firmware. | |||
When reporting an issue, provide: | |||
* Console model | |||
* System firmware version | |||
* Atmosphère version | |||
* Pokémon Legends: Z-A game version | |||
* Lumiose Online mod version | |||
* Exact error messages | |||
* Available diagnostic information | |||
Problems originating from Atmosphère or the console environment may fall outside the scope of Lumiose Online support. | |||
== Collecting Diagnostic Logs == | |||
When troubleshooting an issue: | When troubleshooting an issue: | ||
# Reproduce the problem, if possible. | # Reproduce the problem, if possible. | ||
# Close the game or launcher after the | # Record the exact error message. | ||
# Locate the relevant diagnostic files | # Close the game or launcher after the failure. | ||
# Preserve the | # Locate the relevant diagnostic files. | ||
# | # Preserve the logs generated during the affected session. | ||
# Review the files for sensitive information. | |||
# Attach the relevant logs when requesting support. | |||
{{Notice | |||
|type=warning | |||
|title=Do Not Delete Logs Before Reporting | |||
|Avoid deleting or overwriting diagnostic logs until you have collected the files associated with the failure. Reinstalling or repeatedly relaunching the application may make the original diagnostic information harder to identify. | |||
}} | |||
== Protecting Sensitive Information == | |||
Diagnostic logs may contain system or environment information. | |||
Before sharing them publicly, review the contents for: | |||
* Windows or macOS usernames | |||
* Local file paths | |||
* Public IP addresses | |||
* Authentication tokens or credentials | |||
* Other personally identifiable information | |||
Remove sensitive values where necessary, while preserving the surrounding diagnostic information. | |||
Do not post private keys, passwords, or authentication tokens in public support channels. | |||
== Reporting an Issue == | == Reporting an Issue == | ||
When requesting assistance, | When requesting technical assistance, provide the following information: | ||
* '''Platform:''' Windows standalone, MonZaMac, Eden, or Nintendo Switch | |||
* '''Operating system:''' OS name and version | |||
* '''Game version:''' Installed Pokémon Legends: Z-A version | |||
* '''Lumiose Online version:''' Installed mod or launcher version | |||
* '''Hardware:''' CPU, GPU, and RAM, where applicable | |||
* '''Problem:''' Description of the failure | |||
* '''Reproduction steps:''' Actions required to trigger the problem | |||
* '''Error message:''' Exact text or screenshot | |||
* '''Diagnostic logs:''' Relevant files associated with the failure | |||
If the problem occurs consistently, explain whether it happens every time or only under certain conditions. | |||
For assistance, visit the official Lumiose Online Discord: | |||
[https://discord.gg/nvJ3PpTEc Lumiose Online Discord] | |||
== Related Documentation == | == Related Documentation == | ||
| Line 95: | Line 303: | ||
* [[Troubleshooting]] | * [[Troubleshooting]] | ||
* [[Installation Guide]] | * [[Installation Guide]] | ||
* [[ | * [[Performance & Settings]] | ||
[[Category:Logs & Diagnostics]] | [[Category:Logs & Diagnostics]] | ||
Revision as of 23:11, 13 November 2026
Welcome to the Lumiose Online diagnostic documentation.
This page explains how to collect diagnostic information when troubleshooting installation failures, launcher errors, game crashes, multiplayer connectivity problems, and other technical issues.
Diagnostic logs help the development team identify where a failure occurred and determine which components may be responsible.
Supported Platforms
Lumiose Online supports four installation methods:
| Platform | Installation Method | Diagnostic Information |
|---|---|---|
| Windows | ZA Recomp (Native) | Launcher, gameplay, compilation, and crash logs |
| macOS | MonZaMac (Native) | Platform-specific diagnostic information |
| PC | Eden Emulator | Emulator and mod-related diagnostics |
| Nintendo Switch | Atmosphère | Platform-specific diagnostic information |
The availability and location of diagnostic logs depend on the platform, application version, and type of failure.
Windows Standalone Launcher (ZA Recomp)
The Windows standalone launcher can generate several diagnostic files during installation, game preparation, and execution.
Diagnostic Log Reference
| Log File | Purpose | Useful For |
|---|---|---|
| play.log | Records game execution and runtime events. | Startup failures, gameplay problems, runtime errors |
| crash.log | Records crash-related diagnostic information when available. | Application crashes, exceptions, access violations |
| smoke.log | Records diagnostic output associated with isolated startup or preparation checks. | Isolated startup failures, update preparation problems |
| capture.log | Records diagnostic output associated with preparation or capture operations. | Update preparation and related failures |
Not every installation or failure will generate all of these files.
play.log
The play.log file records information about game execution.
Depending on the launcher version, it may contain:
- ZA Recomp version information
- Windows version
- CPU and system information
- Game initialization events
- Launcher status messages
- Runtime warnings and errors
When to collect:
- The game fails to launch.
- The game starts but encounters errors.
- Gameplay behaves unexpectedly.
- The launcher displays a runtime error.
When possible, reproduce the issue and collect the log from the affected session.
crash.log
The crash.log file may be generated when the game encounters a crash.
Depending on the failure, it may contain:
- Exception codes
- Faulting memory addresses
- Host backtraces
- Guest function references
- Crash-related diagnostic information
For example, an exception code such as 0xC0000005 indicates an access violation.
An access violation alone does not establish the underlying cause. Additional logs and system information may be required.
When to collect:
- The game closes unexpectedly.
- The launcher or game crashes during startup.
- The game crashes during gameplay.
- An exception or backtrace is generated.
smoke.log
The smoke.log file can contain diagnostic information associated with isolated startup or preparation checks.
This log may be relevant when the launcher reports errors such as:
- Update preparation failed
- Isolated startup did not finish
- Game preparation or validation failed
When to collect:
Collect this log when an installation or update preparation operation fails and the file is available.
capture.log
The capture.log file can contain diagnostic information associated with preparation or capture operations.
It may be useful when investigating:
- Update preparation failures
- Game preparation errors
- Failures occurring before normal gameplay begins
When to collect:
Collect this log alongside smoke.log when investigating an update preparation failure, if both files were generated.
Which Logs Should I Collect?
Use the following table to identify the most relevant diagnostic files for a reported issue.
| Problem | Recommended Logs |
|---|---|
| Game fails to start | play.log, crash.log if generated |
| Game crashes during gameplay | crash.log, play.log |
| Update preparation fails | smoke.log, capture.log |
| Isolated startup did not finish | smoke.log, capture.log |
| Game import fails | Relevant launcher or import diagnostic output |
| Multiplayer connection fails | play.log and any relevant connection error messages |
| Performance problems | play.log, hardware specifications, and graphics settings |
These recommendations apply primarily to the Windows standalone launcher.
Other Platforms
MonZaMac (macOS)
MonZaMac provides a native macOS implementation of Pokémon Legends: Z-A.
Diagnostic information may differ from the Windows launcher.
When reporting a problem, provide:
- macOS version
- Mac model and Apple Silicon chip
- MonZaMac release version
- Exact error messages
- Available application logs or crash reports
Eden Emulator (PC)
Eden uses its own emulation environment and diagnostic facilities.
When reporting a Lumiose Online issue while using Eden, provide:
- Eden version
- Operating system
- Pokémon Legends: Z-A game version
- Lumiose Online mod version
- Exact error messages
- Relevant diagnostic information, if available
Nintendo Switch (Atmosphère)
Nintendo Switch installations use Atmosphère custom firmware.
When reporting an issue, provide:
- Console model
- System firmware version
- Atmosphère version
- Pokémon Legends: Z-A game version
- Lumiose Online mod version
- Exact error messages
- Available diagnostic information
Problems originating from Atmosphère or the console environment may fall outside the scope of Lumiose Online support.
Collecting Diagnostic Logs
When troubleshooting an issue:
- Reproduce the problem, if possible.
- Record the exact error message.
- Close the game or launcher after the failure.
- Locate the relevant diagnostic files.
- Preserve the logs generated during the affected session.
- Review the files for sensitive information.
- Attach the relevant logs when requesting support.
Protecting Sensitive Information
Diagnostic logs may contain system or environment information.
Before sharing them publicly, review the contents for:
- Windows or macOS usernames
- Local file paths
- Public IP addresses
- Authentication tokens or credentials
- Other personally identifiable information
Remove sensitive values where necessary, while preserving the surrounding diagnostic information.
Do not post private keys, passwords, or authentication tokens in public support channels.
Reporting an Issue
When requesting technical assistance, provide the following information:
- Platform: Windows standalone, MonZaMac, Eden, or Nintendo Switch
- Operating system: OS name and version
- Game version: Installed Pokémon Legends: Z-A version
- Lumiose Online version: Installed mod or launcher version
- Hardware: CPU, GPU, and RAM, where applicable
- Problem: Description of the failure
- Reproduction steps: Actions required to trigger the problem
- Error message: Exact text or screenshot
- Diagnostic logs: Relevant files associated with the failure
If the problem occurs consistently, explain whether it happens every time or only under certain conditions.
For assistance, visit the official Lumiose Online Discord: