Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Get-Started Docs pass #133

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

KobeRiddle-dev
Copy link

Improved all .md files under Get-Started for clarity, informational consistency, and native English feel.

Copy link
Member

Choose a reason for hiding this comment

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

Please remove that file from PR. I'll add vscode folder to git ignore.

Copy link
Author

Choose a reason for hiding this comment

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

I believe I have done so now.

Comment on lines -36 to +51
* **Binaries** - compiled game scripts binaries
* **Cache** - editor local cache folder, buid cache, used for thumbnails, game cooker cache and other temporary files
* **Content** - contains all the game assets (models, textures, settings, etc.)
* **SceneData** - dedicated directory for the [private scene assets](scenes/scene-data.md)
* **Shaders** - auto-improted shaders assets (from source)
* **GameSettings.json** - fixed location for the game settings asset
* **Logs** - contains editor log files (and crash dumps)
* **Screenshots** - contains screenshot files (`.png` format) you took in editor (use the `F12` key)
* **Source** - contains all game script files (C++ and C# scripts) organized into modules
* **Shaders** - shader source files
* **<GameModule>** - subfolder with game module code
* **<GameModule>.Build.cs** - game module build script
* **GameTarget.Build.cs** - game target build configuration script
* **GameEditorTarget.Build.cs** - editor target build configuration script
* **<project_name>.sln** - project scripts solution file, open it with Visual Studio
* **<project_name>.flaxproj** - project description and metadata file (used by editor and launcher)
* **Binaries** - compiled game scripts binaries
* **Cache** - editor local cache folder, build cache, used for thumbnails, game cooker cache and other temporary files
* **Content** - contains all the game assets (models, textures, settings, etc.)
* **SceneData** - dedicated directory for the [private scene assets](scenes/scene-data.md)
* **Shaders** - auto-imported shaders assets (from source)
* **GameSettings.json** - fixed location for the game settings asset
* **Logs** - contains editor log files (and crash dumps)
* **Screenshots** - contains screenshot files (`.png` format) you took in editor (use the `F12` key)
* **Source** - contains all game script files (C++ and C# scripts) organized into modules
* **Shaders** - shader source files
* **<GameModule>** - subfolder with game module code
* **<GameModule>.Build.cs** - game module build script
* **GameTarget.Build.cs** - game target build configuration script
* **GameEditorTarget.Build.cs** - editor target build configuration script
* **<project_name>.sln** - project scripts solution file, open it with Visual Studio
* **<project_name>.flaxproj** - project description and metadata file (used by editor and launcher)
Copy link
Member

Choose a reason for hiding this comment

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

Indentation should preserve some subfolders such as SceneData and Shaders which should go under Content in a tree list.

@@ -17,15 +17,17 @@ You can also add new actors using a Context Menu in a *Scene* window. Right-clic

![Scene Window Spawn Actor](media/context-menu-spawning.jpg)

## Placing actors using Drag and Drop
## Placing actors from the Content Browser using Drag and Drop
Copy link
Member

Choose a reason for hiding this comment

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

Content Window not Browser

manual/toc.md Outdated
Copy link
Member

Choose a reason for hiding this comment

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

I'd leave this file without adding those newlines so it's smaller and easier to scroll/edit.

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

Successfully merging this pull request may close these issues.

2 participants