Skip to content

(#220) Write, build and load a business logic module for Logos#227

Merged
cheny0 merged 9 commits into
mainfrom
220-write-build-and-load-a-business-logic-module-for-logos
May 27, 2026
Merged

(#220) Write, build and load a business logic module for Logos#227
cheny0 merged 9 commits into
mainfrom
220-write-build-and-load-a-business-logic-module-for-logos

Conversation

@cheny0

@cheny0 cheny0 commented Apr 17, 2026

Copy link
Copy Markdown
Contributor

The content for wrapping a C library will be covered in a separate document

@cheny0 cheny0 requested a review from fryorcraken April 17, 2026 10:51
@cheny0 cheny0 self-assigned this Apr 17, 2026
@cheny0 cheny0 added area:core Docs related to Logos Core journeys. quality:unverified Structured draft with steps, but not confirmed by an SME. type:journey A user journey document (the primary deliverable). release:testnet-v0.2 Items for Testnet v0.1 release. labels Apr 17, 2026
@cheny0 cheny0 added this to the Testnet v0.2 milestone Apr 17, 2026
@cheny0 cheny0 linked an issue Apr 17, 2026 that may be closed by this pull request
@fryorcraken

This comment was marked as low quality.

@fryorcraken

Copy link
Copy Markdown
Contributor

Apologies for the comment above, probably due from me moving away from the tutorial-v1 tag. Will review today.

@fryorcraken

Copy link
Copy Markdown
Contributor

FYI logos-co/logos-tutorial#39

Also, note a working example that follows the docs as closely as possible: fryorcraken/logos-module-tictactoe#5

@fryorcraken

Copy link
Copy Markdown
Contributor

Better qml example: https://github.com/fryorcraken/logos-tictactoe-qml

@cheny0

This comment was marked as resolved.

1. Build the development version of `logos-basecamp`.

```bash
nix build 'github:logos-co/logos-basecamp/tutorial-v1#app' --out-link ./logos-basecamp

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shouldn't it use the latest release of logos-basecamp?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it should. unless this doc is linked to tutorial-V1

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@fryorcraken @Khushboo-dev-cpp, the original tutorial uses the tutorial-v1 tag. Should I change it?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, let's make the doc work for tutorial-v1 as per the original tutorial, and tutorial-v1 tag on the logos-tutorial repo


> [!NOTE]
>
> For other module types, check out [Wrap a C Library as a Logos core module](./wrap-a-c-library-as-a-logos-core-module.md), [Build a QML UI for your logos module](./build-a-qml-ui-for-your-logos-module.md) and [Build a Logos C++ UI module](./build-a-logos-cpp-ui-module.md).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wrong link

Suggested change
> For other module types, check out [Wrap a C Library as a Logos core module](./wrap-a-c-library-as-a-logos-core-module.md), [Build a QML UI for your logos module](./build-a-qml-ui-for-your-logos-module.md) and [Build a Logos C++ UI module](./build-a-logos-cpp-ui-module.md).
> For other module types, check out [Wrap a C Library as a Logos core module](./wrap-a-c-library-as-a-logos-module.md), [Build a QML UI for your logos module](./build-a-qml-ui-for-your-logos-module.md) and [Build a Logos C++ UI module](./build-a-logos-cpp-ui-module.md).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually, in the PR for this tutorial, it's called a logos core module: #239. I'll remove the file in this PR.

Comment thread docs/core/journeys/build-run-a-logos-core-module.md Outdated
Comment thread docs/core/journeys/build-run-a-logos-core-module.md Outdated
Comment thread docs/core/journeys/build-run-a-logos-core-module.md Outdated
Comment thread docs/core/journeys/build-run-a-logos-core-module.md Outdated
Co-authored-by: Sasha <118575614+weboko@users.noreply.github.com>
Comment on lines +89 to +93
```bash
mv src/my_module_interface.h src/<module_name>_interface.h
mv src/my_module_plugin.h src/<module_name>_plugin.h
mv src/my_module_plugin.cpp src/<module_name>_plugin.cpp
```

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

seems like there is different placeholder

Suggested change
```bash
mv src/my_module_interface.h src/<module_name>_interface.h
mv src/my_module_plugin.h src/<module_name>_plugin.h
mv src/my_module_plugin.cpp src/<module_name>_plugin.cpp
```
```bash
mv src/minimal_interface.h src/<module_name>_interface.h
mv src/minimal_plugin.h src/<module_name>_plugin.h
mv src/minimal_plugin.cpp src/<module_name>_plugin.cpp

@cheny0 cheny0 merged commit 052f4a6 into main May 27, 2026
@cheny0 cheny0 deleted the 220-write-build-and-load-a-business-logic-module-for-logos branch May 27, 2026 07:03
@weboko

weboko commented May 27, 2026

Copy link
Copy Markdown
Contributor

@cheny0 there are some additions I wanted to add to this PR.

some inconsistencies, fixes to paths and added some notes
#280

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area:core Docs related to Logos Core journeys. quality:unverified Structured draft with steps, but not confirmed by an SME. release:testnet-v0.2 Items for Testnet v0.1 release. type:journey A user journey document (the primary deliverable).

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Write, build and load a business logic module for Logos

5 participants