flaxengine / flaxdocs Goto Github PK
View Code? Open in Web Editor NEWFlax Engine Documentation
Home Page: https://docs.flaxengine.com
License: Creative Commons Attribution 4.0 International
Flax Engine Documentation
Home Page: https://docs.flaxengine.com
License: Creative Commons Attribution 4.0 International
For example ,i'm reading the docs of platform/uwp, it mentioned that it need the v141(2017),
but didn't talk about the specific tool to install in visualstudio.
I checked the vs installer , there are several kinds including c++ tool with spectre、MSVC c++ tool.
Add documentation to Scripting section about creating Actors on C++ or/and C#
https://docs.flaxengine.com/manual/scripting/debugging/visual-studio-code.html is outdated, since Microsoft is working on some new C# extensions
C# Dev Kit builds on the same foundations as Visual Studio for some of its functionality, it uses the same license model as Visual Studio. This means it's free for individuals, as well as academia and open-source development, the same terms that apply to Visual Studio Community. For organizations, the C# Dev Kit is included with Visual Studio Professional and Enterprise subscriptions, as well as GitHub Codespaces. For full terms and details see the license terms.
I'm working on Flax at 3am...
i have a doubt...
i go to documentation...
LIGHT THEME
O MY GOD I'M BLIND
pls add dark theme :)
Scripts/... Should be replaced with Source/... since no Scripts folder exists by default
I attempted to fix a broken link, but it seems i need to clone the whole repo to do so?
https://github.com/FlaxEngine/FlaxDocs/blob/c8d26bc70962ea9bdc52d12043d84f1cff1df19d/manual/get-started/requirements.md/#L1
the link to the .net sdk starts with ttps: when of course it should be https:
Perhaps a public Wiki would make more sense
jb-perrier fixed the flashing tooltips on high DPI screens. I took a look at it and realized that I don't get why it was wrong before and why it's correct now. So I went ahead, dug through the source code and hopefully understand it correctly.
To save other developers the trouble of figuring it out themselves, I think we should document it. Where should I place the following documentation? (after cleaning it up a bit more)
Answer: maybe inside UI as subpage?
On the low level end of things https://github.com/FlaxEngine/FlaxEngine/blob/be1b9857f9d219811febf18e144fa4d1e63ca9fa/Source/Engine/Platform/Windows/WindowsWindow.cpp#L384-L393, the size is "correct", as in, a monitor pixel is exactly one UI pixel.
However, when translating that into something for an application (UI system), you have to take care of the DPI scale (≥ 1). With a DPI scale of two, UI pixels are twice as large as the monitor pixels.
Screen space: No DPI applied, stretches across all monitors
Window space:
Local control space:
https://docs.flaxengine.com/manual/scripting/debugging/index.html explains how one debugs their scripts.
It should also include a note regarding debugging engine code. Something along the lines of "if you want to debug FlaxEngine code, you will need...".
In your docs you use "builded" as the past tense of build, this is incorrect. The correct word is "built".
I'd make the corrections myself and submit them but I have never done that sort of thing in GitHub, still rather noob at it other than cloning projects.
Current JSON example only showcases extremely basic string serialization of an arbitrary object, without even showing what you are supposed to do with the resulting CompactJsonWriter
. Here is how this needs to be extended:
The FlaxDocs repository currently is all rights reserved.[1]
This is a problem, and we'd like to ask you for permission to change the license to the very permissive Creative Commons Attribution 4.0 International.
Pinging @mafiesto4 @stefnotch @herocrab @W2Wizard @bolognatic @Withaust @MinhCT @jb-perrier @iainmckay @Wolfos @mxruben @honzapatCZ @NordonOscillius @Galbi3000 @mlavik1 @realDLPS @tom-weiland @nothingTVatYT @nove1398 @molodoy-chelovek @brbrmensch @Clawthorn @GoaLitiuM @Evildea @iliyalb @jfaz13 @Muchaszewski , since you contributed to this repository. Thank you very much for improving the documentation by the way! <3
If you're fine with changing the license, please respond to this issue.
Disclaimer: I'm not a laywer, the following is just my very limited understanding of the rules. Please actually ask a lawyer when you have legal questions.
In most countries (jurisdictions), when you create something, you own it. (copyright)
For anyone else to view it, or to change it, or similar, they have to get your permission. (lots of exceptions)
The reason why things can be put onto GitHub, and why other people can look at it, is because of their Terms of Service. The GitHub ToS basically says "you uploaded public code to GitHub, now GitHub is allowed to display the code".
Most projects actually want people to be able to use their work, to contribute and more. For example, it should be possible to copy-paste a snippet of the documentation and put it into your code. This is why nearly every project has a license. A license is the legal document that actually allows you to do certain things, as long as you follow the rules.
The FlaxDocs repository doesn't have LICENSE file or anything. This means that the default still applies, where everyone owns their contributions. (all rights are reserved). This is not ideal. We'd like to fix that, by changing the license to the very open CC BY 4.0 license. That effectively means that
Once i found out about Flax, the first thing i did was to look in the documentation for a starting out guide. However, seeing this:
left a really bad taste in my mouth. I get that it is a small joke but when it's the first thing a potetional user might see, imho it makes Flax look unprofessional for throwing shade at other engines. These pages should focus on making a great first impression and teaching a new user how to use the engine.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google ❤️ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.