CSharpWasm support JS side by daosgava · Pull Request #120 · thoth-tech/SplashkitOnline

daosgava · 2025-05-11T13:30:56Z

Description

This PR is a follow up of the #106 pull request.

This change modifies Browser_IDE/CSharpWasm/main.js to read methods from splashKitMethods.generated.js, which is generated by the splashkit-translator as introduced in PR #24. It also includes CSharpWasm/SplashKitBindings.Generated.cs, likewise generated by the translator.

Process to replace generated files

Generate SplashKit.Generated.cs and splashKitMethods.generated.js using the translator.
Copy splashKitMethods.generated.js into Browser_IDE/CSharpWasm/.
Copy SplashKit.Generated.cs into CSharpWasm/.
Change directory to CSharpWasm/ and run ./buildAndCopy.sh.
Change directory to Browser_IDE and run npm run server

Note: Files were already added to this PR.

…sed workerEventProcessor

…de, update event handling for compile and run

…eation

github-actions · 2025-05-11T13:32:07Z

🐋 PR Preview!
Preview at https://thoth-tech.github.io/SplashkitOnline/pr-previews/120
for commit `1551b4c`

Oliver-Quail

Hi Daniel,
Firstly great commit. I've made some comments mainly regarding adding some more documentation and other minor tweaks. Then I'll be happy to approve.
Also can confirm that this works and runs on Linux :)

Oliver-Quail · 2025-05-15T23:47:55Z

CSharpWasm/README.md

+
+### Running the Build and Copy Script
+
+To build the project and copy the necessary files into the `Browser_IDE/CSharpWasm` directory, run the following shell script:


It is hard to tell what files I need to build the project, please can you add clarification for this step regarding the following:

What files do I need to copy?

Do I need any build tools (e.g. dotnet framework)?

You don’t need to copy the files manually here, as this process is automated by CSharpWasm/buildAndCopy.sh. See the command below.

./buildAndCopy.sh

Regarding the build tools, you need to have .NET installed. You can find more information in the research findings document.

https://github.com/thoth-tech/SplashkitOnline/blob/main/Documentation/Research%20and%20Findings/splashkit-online-c-sharp-support-research.md

Note: We discussed in the last weekly meeting that all of these scripts and copy/paste steps will be added to a pipeline, so that everything is in place when the project is built.

Let me create a card to document all of this. 🙂

Oliver-Quail · 2025-05-16T00:02:23Z

.gitignore

 splashkit/
 generated/
 __pycache__/
+_framework/


I noticed when running the buildAndCopy.sh script.
It created files in Browser_IDE/CSharpWasm/bin
Is this supposed to be ignored two

No, those are the actual libraries that allow compiling C# in the browser :)

Oliver-Quail · 2025-05-16T00:07:11Z

CSharpWasm/Properties/launchSettings.json

+        "applicationUrl": "https://localhost:7281;http://localhost:5178",
+        "inspectUri": "{wsProtocol}://{url.hostname}:{url.port}/_framework/debug/ws-proxy?browser={browserInspectUri}",


Would it be possible to get some documentation on these two lines and how they relate to the execution of C#?

This is part of the boilerplate generated with the project. This template allows running a server with the C# part, but we don’t actually use that feature since we’re only compiling and generating the .dll files.

By the way, the research document provides more detail. Check this section:
https://github.com/thoth-tech/SplashkitOnline/blob/main/Documentation/Research%20and%20Findings/splashkit-online-c-sharp-support-research.md#wasm-tools

Oliver-Quail · 2025-05-16T00:08:29Z

CSharpWasm/buildAndCopy.sh

If you have time would it be possible to convert this to a python script so people who use windows can also install this. If there is no time please add a card to the planner board :)

That’s a great catch! I’ll add a card for it. 😊

I think this need may need to be discussed whether its needed. I tested on windows and due to MSYS, it runs successfully. I believe people working with splashkit on windows will most definitely have this, however it may need confirmation further than my thoughts

Oh, nice! Thank you for checking that out. Let me add it to the document I'm preparing. :)

Oliver-Quail

I approve this PR, good job Daniel

cameronhum

Other than that one broken change I suggested. This is very easy to understand with the documentation you put together and I was able to use the build script and test easily. This code does its functionality and I will be happy to approve it once that small change is adjusted.

cameronhum · 2025-05-21T00:51:36Z

Browser_IDE/projectInitializer.js

+
+            // Example 3: Print combination of explicit string and value of string variable
+            string hello = "Hello";
+            SplashKit.WriteLine(hello + " World!\nDon't forget spaces between words when printing to the terminal!");


the \n causes syntax errors on first new project load as its interpreted to be a newline in the code editor rather than '\n'. it may need to be escaped somehow so that it does the intended task

Looking into it :)

cameronhum

The only issue I had with the pull request has now been resolved and I am happy to approve this to go onto next review. Thank You!

daosgava added 17 commits December 14, 2024 19:01

Add initial C# WebAssembly project structure and setup

45c3674

Refine .gitignore to streamline ignored files and directories

2b8ae27

Add C# support with compiler and runtime integration

da18768

Refactor C# runtime integration: update event handling and remove unu…

0f58d42

…sed workerEventProcessor

Remove redundant console log for IDE initialization

606ac85

Merge branch 'main' into wasm-csharp-interop

8b9ff86

Update comment for clarity in CSharpCompiler registration

4b302ed

Refactor C# WebAssembly integration: remove run button and related co…

d7f6529

…de, update event handling for compile and run

Remove redundant console log in project initializer for C# project cr…

144c5e5

…eation

CSharpWasm.dll update

2d6035c

Overload write_line function

cff1e1c

add error handling and namespace

f4b75ae

fix indentation, use sample from splash kit website

92583f0

Add comments with future work

4358d72

Improve comments and remove unnecessary methods

de6d8e5

add parseMethods function and generated bindings

eb51219

Remove unnecessary comments

1453d30

daosgava temporarily deployed to static-site May 11, 2025 13:31 — with GitHub Actions Inactive

Oliver-Quail reviewed May 16, 2025

View reviewed changes

Oliver-Quail approved these changes May 18, 2025

View reviewed changes

cameronhum suggested changes May 21, 2025

View reviewed changes

Address newline character issue.

0068ea7

daosgava temporarily deployed to static-site May 21, 2025 13:50 — with GitHub Actions Inactive

daosgava requested a review from cameronhum May 25, 2025 13:58

cameronhum approved these changes May 26, 2025

View reviewed changes

Merge branch 'main' into wasm-csharp-js

1551b4c

Oliver-Quail temporarily deployed to static-site July 11, 2025 00:13 — with GitHub Actions Inactive

Oliver-Quail merged commit 66dec2f into thoth-tech:main Jul 11, 2025
2 checks passed

Oliver-Quail requested a deployment to static-site July 11, 2025 00:14 — with GitHub Actions In progress


		### Running the Build and Copy Script

		To build the project and copy the necessary files into the `Browser_IDE/CSharpWasm` directory, run the following shell script:

		"applicationUrl": "https://localhost:7281;http://localhost:5178",
		"inspectUri": "{wsProtocol}://{url.hostname}:{url.port}/_framework/debug/ws-proxy?browser={browserInspectUri}",

Conversation

daosgava commented May 11, 2025

Description

Process to replace generated files

Uh oh!

github-actions bot commented May 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Oliver-Quail left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cameronhum May 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Oliver-Quail left a comment

Choose a reason for hiding this comment

Uh oh!

cameronhum left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

cameronhum left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Comments

github-actions bot commented May 11, 2025 •

edited

Loading

Oliver-Quail left a comment •

edited

Loading

cameronhum May 21, 2025 •

edited

Loading